Skip to content

docs: add Signed commits section to CONTRIBUTING - #30

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

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: ca7894cb-271d-423f-8654-a7b9e4370c59

📥 Commits

Reviewing files that changed from the base of the PR and between 9ba5da2 and 7ac2023.

📒 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. (20)
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: secret-scan / gitleaks
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: secret-scan / shell-secrets
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Actions lockfile verify
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: secret-scan / rust-secrets
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: analyze (javascript-typescript, none)
  • GitHub Check: Hypatia Neurosymbolic Analysis
  • GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)

123-138: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Added guidance requiring signed commits for changes merged into the default branch, including setup instructions and supported commit workflows. Unsigned commits block merging, and rebase merges are unavailable.

Walkthrough

The contribution guide now requires signed commits to reach the default branch. It gives signing and commit-submission instructions for people, interactive agents, apps, bots and workflows, and describes the merge methods and restrictions.

Changes

Signed Commit Policy

Layer / File(s) Summary
Commit signing and merge guidance
.github/CONTRIBUTING.md
The guide specifies signing requirements and methods, API-based commit creation for apps, bots and workflows, squash merges, and restrictions on unsigned commits and rebase merges.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: metadatastician

Merge Risk: ⚪ Minimal · up to 7ac20

The signing and squash guidance is supported by the repository’s active signature requirement. No established issue blocks this documentation change; the rebase-merge setting remains unconfirmed.

Architecture Summary

Architecture risk: 🔵 Low · up to 7ac20

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: Adds signed-commit requirements and instructions: people and interactive agents use a registered GitHub SSH signing key and verified committer email; apps, bots and workflows submit commits through the API rather than pushing local commits. It directs contributors to squash-merge, states that unsigned PR-branch commits block merging, and notes that rebase-merge is disabled because replayed commits are unsigned.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation change: adding a Signed commits section to CONTRIBUTING.
Description check ✅ Passed The description directly explains the signed-commits documentation, the signing policy, and the related contributor guidance.
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 checks each commit’s mark
SSH keys sign before the push
Bots send commits through API
Squash merges keep the branch in line
Signed hops reach the default branch

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

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR

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