Skip to content

docs: add Signed commits section to CONTRIBUTING - #120

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: d63750ee-b955-4e33-9d10-b2c87ac48df9

📥 Commits

Reviewing files that changed from the base of the PR and between e3edf30 and 8e1ab13.

📒 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: governance / Workflow security linter
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: scan / shell-secrets
  • GitHub Check: analysis / Run Scorecard PR
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: lint
  • GitHub Check: Zig FFI build + test
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Validate K9 contracts
  • GitHub Check: antipattern-check
  • GitHub Check: Validate DEED manifests
  • GitHub Check: analyze (actions, none)
  • GitHub Check: Idris2 proofs + tests
  • GitHub Check: check
  • 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 reaching the default branch, including requirements for people, automation and pull requests.
    • Documented squash merging and how to handle unsigned commits.

Walkthrough

The contribution guide now requires signed commits on the default branch. It describes signing methods for people, interactive agents, apps, bots and workflows, and explains the commit checks and merge requirements for pull requests.

Changes

Commit signing requirements

Layer / File(s) Summary
Signing and merge requirements
.github/CONTRIBUTING.md
The guide describes signing commits with a registered SSH signing key and verified committer email, or using the GitHub commit API or signed-push action for apps, bots and workflows. It states that unsigned pull request commits block merging, requires squash merges, and describes recreating unsigned commits as signed commits in a new pull request.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 8e1ab

This documentation change appears ready to merge: checked-in guidance and automation align with it, and no concrete user-impacting defect was found. The external ruleset and estate policy were not independently verified.

Architecture Summary

Architecture risk: 🔵 Low · up to 8e1ab

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: Added signing requirements and instructions covering SSH key setup for people and interactive agents, API-based commits for apps, bots and workflows, and squash merging. The text states that unsigned PR-branch commits block merging, recommends recreating them as signed commits in a new PR, and notes that rebase-merge is disabled.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: adding a Signed commits section to CONTRIBUTING.
Description check ✅ Passed The description directly explains the documentation change, its signing policy, and its repository context.
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 signs each commit with care,
Then checks that every mark is there.
The squash brings changes to the branch,
While unsigned commits wait and blanch.
New signed commits hop into place,
And leave a tidy merge-trail trace.

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

@hyperpolymath
hyperpolymath merged commit 95bf698 into main Oct 1, 2026
41 checks passed
@hyperpolymath
hyperpolymath deleted the docs/signing-policy-d218 branch October 1, 2026 21:42
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