Skip to content

docs: add Signed commits section to CONTRIBUTING - #125

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: c2c5d26b-9ca9-4b48-9fef-6978127c71a7

📥 Commits

Reviewing files that changed from the base of the PR and between 017cd7b and d2bd42d.

📒 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. (22)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: scan / gitleaks
  • GitHub Check: scan / shell-secrets
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Actions lockfile verify
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: Agda proofs (--safe)
  • GitHub Check: KRL fragment and evaluator tests (Julia)
  • GitHub Check: Build and test Julia verification image
  • GitHub Check: TLA+ model check (TLC)
⚠️ CI failures not shown inline (1)

Commit Status: Codeac analyze results: Codeac analyze results

Conclusion: failure

Codeac was not able to perform analysis.
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)

125-140: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Added guidance on commit-signing requirements, including the accepted signing methods and how to handle branches with unsigned commits.
    • Clarified that pull requests must use squash merges; rebase merges are disabled.

Walkthrough

The contribution guide adds instructions for signed commits, signing methods for different contributors and automation, and merge requirements for pull requests.

Changes

Signed commit guidance

Layer / File(s) Summary
Commit signing and merge requirements
.github/CONTRIBUTING.md
The guide requires signed commits on pull request branches and squash merges. It explains how people and automation must sign commits, and how to replace unsigned commits with signed cherry-picks. It also states that rebase-merge is disabled.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to d2bd4

The contribution guide’s signing and squash-merge steps match the stated enforcement behavior; no merge-blocking risk is established.

Architecture Summary

Architecture risk: 🔵 Low · up to d2bd4

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 guidance on signed commits: people and interactive agents use registered SSH signing keys with the specified Git settings and a verified committer email; apps, bots and workflows write commits through the API or signed-push action. It states that every commit on a PR branch must be signed, prescribes squash merges, and directs contributors to recreate branches with signed cherry-picks when unsigned commits block merging; 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 signing-policy 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.
✨ 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,
An SSH key marks the trail.
Squash the branch before the merge,
Signed cherry-picks replace the stale.
The guide records the steps with flair,
Then hops away, ears in the air.

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

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