Skip to content

docs: add Signed commits section to CONTRIBUTING - #131

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: ac7a8aae-555c-44c1-a993-616963d72bbc

📥 Commits

Reviewing files that changed from the base of the PR and between b007d33 and 13a8324.

📒 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. (24)
  • GitHub Check: rust-ci / Detect Cargo.toml
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / shell-secrets
  • GitHub Check: scan / gitleaks
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: Validate eclexiaiser manifest
  • GitHub Check: Groove manifest check
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Validate DEED manifests
  • GitHub Check: panic-attack assail
  • GitHub Check: ABI ↔ FFI structural conformance
  • GitHub Check: Hypatia neurosymbolic scan
  • GitHub Check: Zig FFI builds + tests (Zig 0.14.0)
  • GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)

123-138: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Added guidance on commit signing, including supported signing methods and the requirements for pull request commits and merging.

Walkthrough

The contribution guide now requires signed commits and documents signing procedures for people, interactive agents, apps, bots and workflows. It also sets squash merging as the required pull request merge method and explains how to replace unsigned commits.

Changes

Signed commit guidance

Layer / File(s) Summary
Signing requirements and merge rules
.github/CONTRIBUTING.md
The guide specifies SSH signing for people and interactive agents, API-based commits for apps, bots and workflows, and verified committer email. It requires squash merges and signed commits on pull request branches. It also states that rebase merging is disabled.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 13a83

The signed-commit and squash-merge guidance matches GitHub’s documented behavior. No actionable merge risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to 13a83

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 signing procedures: people and interactive agents use a registered GitHub SSH signing key and verified committer email; apps, bots and workflows write commits through the API rather than pushing locally. PRs must be squash-merged because the ruleset checks every branch commit; unsigned commits require a new branch of signed commits, and rebase-merge is disabled.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the purpose and main changes, but it does not follow the repository template. It omits the Changes section format, the RSR Quality Checklist, and a clear Testing section. It a… Restructure the description using the repository template. Add the Summary, Changes, RSR Quality Checklist, and Testing sections. Mark each applicable checklist item and state that no tests were required for this documentation-only change. …
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main 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 and main changes, but it does not follow the repository template. It omits the Changes section format, the RSR Quality Checklist, and a clear Testing section. It also does not state whether the applicable documentation and licence checks were completed.

Resolution

Restructure the description using the repository template. Add the Summary, Changes, RSR Quality Checklist, and Testing sections. Mark each applicable checklist item and state that no tests were required for this documentation-only change. Keep Screenshots marked as not applicable, if appropriate.

  • 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 a commit with care,
Then checks the branch is signed and fair.
A squash-merge carries work along,
While SSH keys join the song.
The guide now tells each step to take.

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 6b938f7 into main Oct 1, 2026
31 of 36 checks passed
@hyperpolymath
hyperpolymath deleted the docs/signing-policy-d218 branch October 1, 2026 21:20
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