Skip to content

docs: add Signed commits section to CONTRIBUTING - #132

Merged
hyperpolymath merged 2 commits into
mainfrom
docs/signing-policy-d218
Oct 1, 2026
Merged

hyperpolymath merged 2 commits 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 Sep 30, 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: 28d413db-ae72-4d9c-a182-562829064bd9

📥 Commits

Reviewing files that changed from the base of the PR and between 880f66a and 49b61a7.

📒 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. (18)
  • GitHub Check: scan / gitleaks
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / shell-secrets
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: spark-theatre-gate / SPARK Theatre Gate
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Banned-pattern gate
  • GitHub Check: Lean 4 (lake build)
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)

123-138: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Added guidance on commit-signing requirements for changes reaching the default branch, including how people, interactive agents, apps and workflows should create signed commits.
    • Clarified that unsigned pushes are rejected, every commit on a pull request branch is checked, and squash merges are required. Branches containing unsigned commits must be recreated with signed commits, and rebase merges are disabled.

Walkthrough

The contribution guide adds signed-commit requirements and instructions for people and automated processes. It also explains pull request commit checks and merge rules.

Changes

Commit guidance

Layer / File(s) Summary
Signed commit instructions
.github/CONTRIBUTING.md
The guide specifies SSH signing for people and interactive agents, and GitHub API or signed-push action commits for apps, bots and workflows. It requires squash merges, explains that every pull request branch commit is checked, and instructs contributors to recreate branches that contain unsigned commits.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 49b61

This change documents signed-commit and squash-merge expectations. The available evidence supports the PR-branch signature requirement; no actionable merge-blocking issue was established.

Architecture Summary

Architecture risk: 🔵 Low · up to 49b61

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 instructions for people, interactive agents, apps, bots and workflows. It specifies squash merges, explains that every PR-branch commit is checked and unsigned commits block merging, instructs contributors to recreate unsigned branches with signed commits, and states that 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, its signing policy, and the related contributor 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.
  • 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 hops through checks without a scare.
Squash the branch and make it neat,
Signed commits keep the rules complete.
The guide now shows the way to go.

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