Skip to content

docs: add Signed commits section to CONTRIBUTING - #75

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
@github-actions github-actions Bot added documentation Docs, prose, diagrams, READMEs, ADRs ci labels Oct 1, 2026
@coderabbitai

coderabbitai Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

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: 5bb6c2d1-efd2-4933-b783-7fe7f5b55a38

📥 Commits

Reviewing files that changed from the base of the PR and between e45f3cd and c33e253.

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

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. (17)
  • GitHub Check: scan / gitleaks
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / shell-secrets
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: Lint
  • GitHub Check: Ada TUI Build
  • GitHub Check: Hugo Build
  • GitHub Check: Security Scan
  • GitHub Check: Julia Tests
  • GitHub Check: Welcome
  • GitHub Check: Container Build
  • GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (4)
.github/CONTRIBUTING.md (3)

328-335: LGTM!


336-339: 🎯 Functional Correctness

The repository merge settings and applicable ruleset are not available in the supplied source. The squash-only requirement cannot be confirmed from the documentation files alone.


326-327: 🎯 Functional Correctness

The concern is refuted. The repository has an active Require-Signed-Commits ruleset with required_signatures applied to ~DEFAULT_BRANCH. The statements in both documents describe a live repository control.

CONTRIBUTING.adoc (1)

118-125: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidance to require signed commits for changes reaching the default branch. Unsigned commits on pull-request branches prevent merging.
    • Added signing instructions for people, interactive agents, apps, bots and workflows, including the use of verified committer email addresses.
    • Explained how to replace unsigned commits with signed cherry-picks and submit a new pull request.
    • Clarified that pull requests must use squash merges; rebase merges are disabled.

Walkthrough

Both contributor guides now document signed-commit requirements, signing methods for different contributor types, and merge rules.

Changes

Signed-commit policy

Layer / File(s) Summary
Document signing and merge rules
.github/CONTRIBUTING.md, CONTRIBUTING.adoc
Both guides require signed commits. They describe signing methods for people and automated contributors, require squash merges, explain how unsigned commits affect merging, and provide instructions to recreate a branch with signed commits.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to c33e2

The guides document signed-commit requirements and contribution workflows without changing runtime behavior. No concrete merge-blocking issue is established.

Security Architecture Review

Security architecture risk: 🔵 Low · up to c33e2

The change documents signing and merge requirements without modifying permissions or enforcement. No introduced security weakness was established, but the stated repository controls and automation signing behavior could not be independently verified.

Retained concerns
No architecture-level concerns identified.

Security review details

Security Blast Radius

  • inferred — The supported impact is contributor behavior and expectations about default-branch admission. The inspected change does not itself expand credentials, service access, or deployment authority.

Trust Boundaries and Controls

  • observed — The documentation places commit signing at the contributor-to-default-branch trust boundary and describes GitHub as the signing authority for API-created automation commits. It does not supply evidence establishing the effective ruleset, bypass permissions, merge settings, or external signing action behavior.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarises the main documentation change: adding a Signed commits section to CONTRIBUTING files.
Description check ✅ Passed The description directly explains the signed-commit guidance, affected contributor workflows, merge requirements, and docs-only scope of the changes.
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.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR
  • 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
SSH keys tucked beneath one ear
Squash merges carry changes through
Unsigned branches get signed anew
Then hops away with carrots to share

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

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

Labels

ci documentation Docs, prose, diagrams, READMEs, ADRs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant