Skip to content

docs: add Signed commits section to CONTRIBUTING - #90

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:57

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

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: 23f72c1a-e3f3-497f-b253-ccf4da5311e4

📥 Commits

Reviewing files that changed from the base of the PR and between 56c81bd and 61f854a.

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

427-442: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Contribution guidance now requires commits to the default branch to be signed. It explains signing options for individual contributors, interactive agents, apps, bots and workflows, as well as squash merges. Unsigned commits cannot be merged, and rebase merges are unavailable.

Walkthrough

The contribution guide now describes commit-signing requirements for people, interactive agents, apps, bots, and workflows. It also states that unsigned commits block merging and that squash merging is required because rebase-merge is disabled.

Changes

Commit signing guidance

Layer / File(s) Summary
Signing and merge workflows
.github/CONTRIBUTING.md
Adds SSH signing instructions for people and interactive agents, API-based commit creation instructions for apps, bots, and workflows, and guidance on squash merges and unsigned commits.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 61f85

The guide's signing and merge instructions align with the available evidence, and no merge-blocking issue is established. Repository-specific ruleset settings remain unconfirmed.

Architecture Summary

Architecture risk: 🔵 Low · up to 61f85

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 signing requirements and workflows: people and interactive agents use a registered GitHub SSH signing key and verified committer email; apps, bots and workflows write commits through the API instead of pushing local commits. It also specifies squash merges, explains that unsigned PR-branch commits block merging, and states that rebase-merge is disabled because it replays commits unsigned.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the purpose, policy, implementation details, and scope of the change. However, it does not follow the repository template and omits required sections such as Type of Change, R… Rewrite the description using the repository template. Complete the required sections, mark the documentation update type, list the changes, record testing status and commands, address checklist items, and state any unavailable information …
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation change: adding a Signed commits section to CONTRIBUTING.
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.
Full details: Description check

Explanation

The description explains the purpose, policy, implementation details, and scope of the change. However, it does not follow the repository template and omits required sections such as Type of Change, Related Issues, Changes Made, Testing, Checklist, and Reviewer Checklist.

Resolution

Rewrite the description using the repository template. Complete the required sections, mark the documentation update type, list the changes, record testing status and commands, address checklist items, and state any unavailable information explicitly.

  • Fix all pre-merge checks with AI
  • 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 are ready there
Apps send commits by API
Squash merges keep the branch in line
Unsigned commits must wait outside

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 621bfaf into main Oct 1, 2026
34 of 43 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