Skip to content

docs: add Signed commits section to CONTRIBUTING - #69

Merged
hyperpolymath merged 1 commit into
mainfrom
docs/signing-policy-d218
Oct 1, 2026
Merged

hyperpolymath merged 1 commit into
mainfrom
docs/signing-policy-d218

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Adds a Signed commits section to this repo's CONTRIBUTING, per owner ruling D218. The estate policy is docs/SIGNING-POLICY.adoc in hyperpolymath/standards.

This repo's default branch is covered by the zero-bypass Require-Signed-Commits ruleset, and rebase-merge is off. The section tells contributors what that requires:

  • People and interactive agents sign with an SSH signing key.
  • Apps, bots and workflows write through the API, so GitHub signs their commits.
  • PRs are merged with squash.

If the file already had its own signing section, that section is replaced in place instead of adding a second one. Lines elsewhere that told people to sign with GPG are changed to match the policy (SSH for people).

This is a docs-only change. The commit was created through createCommitOnBranch, so GitHub signs it.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WRvDivYwLSeVCJUrfjic3f

Owner ruling D218. See docs/SIGNING-POLICY.adoc in hyperpolymath/standards.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WRvDivYwLSeVCJUrfjic3f
Copilot AI balanced review requested due to automatic review settings October 1, 2026 05:56

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: fc58d86d-fdaa-496f-9d16-e62e2b90ec01

📥 Commits

Reviewing files that changed from the base of the PR and between 40229f3 and 44f2990.

📒 Files selected for processing (1)
  • .github/CONTRIBUTING.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (12)
  • GitHub Check: github-advanced-security
  • GitHub Check: secret-scan / shell-secrets
  • GitHub Check: secret-scan / rust-secrets
  • GitHub Check: secret-scan / gitleaks
  • GitHub Check: governance-validation
  • GitHub Check: conformance-negative
  • GitHub Check: deed-conformance
  • GitHub Check: membership-integrity
  • GitHub Check: conformance-positive
  • GitHub Check: upstream-pins
  • GitHub Check: CodeQL Analysis (actions, none)
  • GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)

92-93: 🎯 Functional Correctness

Do not state that rebase merging is disabled without a repository setting that supports it.

The active Require-Signed-Commits ruleset targets ~DEFAULT_BRANCH. However, the repository API returned null for allow_rebase_merge and allow_squash_merge, so the claim that rebase merging is disabled remains undecided. The guidance should retain that statement only if an authoritative setting confirms it.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Added contribution guidance on commit signing, including requirements for contributors and automated workflows.
    • Clarified that unsigned commits must be replaced before merging and that squash merging is used.

Walkthrough

The contribution guide now requires signed commits to reach the default branch. It gives signing instructions for people, interactive agents, apps, bots and workflows. It also specifies squash merging and states that rebase merging is disabled.

Changes

Signed commit guidance

Layer / File(s) Summary
Signing and merge instructions
.github/CONTRIBUTING.md
Adds signing requirements and separate procedures for people and interactive agents, and for apps, bots and workflows. Directs contributors to squash-merge, states that unsigned pull request commits block merging, and notes that rebase merging is disabled.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 44f29

The confirmed repository settings match the key signing and merge guidance; no actionable issue is established.

Architecture Summary

Architecture risk: 🔵 Low · up to 44f29

The changed surface does not map to a changed system, dependency edge, entrypoint, or external dependency.

Changed systems: None identified.

Architecture concerns
No architecture-level concerns identified.

Review details

Before / after behavior

  • observed — Modified behavior in .github/CONTRIBUTING.md: Added guidance requiring signed commits on the default branch, with separate signing procedures for people and interactive agents versus apps, bots and workflows. It directs contributors to squash-merge; unsigned commits on a PR branch block merging, and rebase-merge is disabled.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding a Signed commits section to CONTRIBUTING.
Description check ✅ Passed The description directly explains the documentation change and its commit-signing requirements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A rabbit signs each change with care,
Then checks the merge rules waiting there.
SSH keys for people shine,
API commits suit bots in line.
Squash the branch; the guide is clear,
And hop to merge with signed commits here.

Comment @coderabbitai help to get the list of available commands.

@hyperpolymath
hyperpolymath merged commit dfb5f2e into main Oct 1, 2026
17 checks passed
@hyperpolymath
hyperpolymath deleted the docs/signing-policy-d218 branch October 1, 2026 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants