Skip to content

docs: add Signed commits section to CONTRIBUTING - #35

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
@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: 080b1c65-ef86-4002-be38-31fcb1b94c11

📥 Commits

Reviewing files that changed from the base of the PR and between d97ecaa and 99aff60.

📒 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. (18)
  • GitHub Check: secret-scan / gitleaks
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Actions lockfile verify
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: analyze (actions, none)
  • GitHub Check: Canonical Echo correspondence
  • GitHub Check: Proof core and rejection controls
  • GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)

209-209: 🎯 Functional Correctness

The requirement to open a new pull request cannot be decided from the available evidence. .github/CONTRIBUTING.md:209 instructs contributors to create a new pull request, but the applicable D218 or estate rule was not located. GitHub’s documented workflow supports force-pushing the corrected branch, but it does not establish whether the estate imposes an additional requirement.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidance to clarify that commits reaching the default branch must be signed and that pull requests require squash merges.
    • Added instructions for handling branches containing unsigned commits.

Walkthrough

The contribution guide now describes default-branch commit-signing rules, signing methods for different contributors, and pull request branch and merge requirements.

Changes

Commit-signing guidance

Layer / File(s) Summary
Signing and merge requirements
.github/CONTRIBUTING.md
The guide requires signed commits for the default branch and specifies signing methods for people, interactive agents, apps, bots and workflows. It also requires squash merges, directs contributors to recreate unsigned branches with signed commits, and states that rebase-merge is disabled.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 99aff

The guide follows the prescribed signed-commit recovery workflow. No supported merge-blocking issue remains.

Architecture Summary

Architecture risk: 🔵 Low · up to 99aff

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: The previous general signing-key instructions, git log --show-signature verification command and re-sign request are replaced with default-branch ruleset requirements. People and interactive agents must use a registered GitHub SSH signing key and verified committer email; apps, bots and workflows must create commits through the API or estate action. PRs must be squash-merged because every branch commit is checked; unsigned branches must be recreated with signed commits, and rebase-merge is disabled.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation change and the addition of the Signed commits section to CONTRIBUTING.
Description check ✅ Passed The description is directly related to the documentation changes. It explains the signed-commit policy, contributor requirements, merge method, and scope of the change.
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 commit with care,
Then checks the branch before it’s there.
A squash merge keeps the history neat,
Signed commits make the rules complete.
The rabbit hops, content with the feat.

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

@hyperpolymath
hyperpolymath merged commit 7663832 into main Oct 1, 2026
26 of 27 checks passed
@hyperpolymath
hyperpolymath deleted the docs/signing-policy-d218 branch October 1, 2026 20:16
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.

1 participant