Skip to content

docs: add Signed commits section to CONTRIBUTING - #77

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

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: 39e7507f-36ad-4948-8687-8dbe740a3d0d

📥 Commits

Reviewing files that changed from the base of the PR and between 14d4eaf and abd339a.

📒 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: scan / rust-secrets
  • GitHub Check: scan / shell-secrets
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Licence consistency
  • GitHub Check: scan / gitleaks
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: analyze (actions, none)
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Validate DEED manifests
  • GitHub Check: Groove manifest check
  • GitHub Check: Validate eclexiaiser manifest
  • GitHub Check: Patch Bridge CVE triage
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: panic-attack assail
  • GitHub Check: Hypatia neurosymbolic scan
  • GitHub Check: idris2 --check (13 modules)
  • 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 requirements, including accepted signing methods for people, agents and automated workflows.
    • Clarified that unsigned commits must be recreated as signed commits and that pull requests are merged using squash merges.

Walkthrough

The contribution guide adds signed-commit requirements for people, interactive agents, apps, bots and workflows. It also explains how unsigned commits affect merging and states that pull requests must use squash merges.

Changes

Signed commits

Layer / File(s) Summary
Signing and merge requirements
.github/CONTRIBUTING.md
The guide specifies SSH signing for people and interactive agents, API-based signing for apps, bots and workflows, and squash merges. It states that unsigned commits block merging and must be recreated as signed commits.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to abd33

No actionable issue is established in the signed-commit guidance that warrants delaying this documentation change.

Architecture Summary

Architecture risk: 🔵 Low · up to abd33

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 instructions: people and interactive agents use a GitHub-registered SSH signing key and verified committer email; apps, bots and workflows use the API or estate signed-push action rather than pushing local commits. PRs must be squash-merged because the ruleset checks every branch commit; unsigned commits block merging and must be recreated with signed commits, while 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 change and its rationale, but it omits the required template sections for the quality checklist, testing, and screenshots. It also does not use the required Summary, Chang… Update the description to follow the repository template. Add the Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections. Complete each applicable checklist item and state the test result, or mark a section as not applic…
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation change.
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 change and its rationale, but it omits the required template sections for the quality checklist, testing, and screenshots. It also does not use the required Summary, Changes, or Testing headings.

Resolution

Update the description to follow the repository template. Add the Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections. Complete each applicable checklist item and state the test result, or mark a section as not applicable with a reason.

  • 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,
Then checks the branch before the merge.
Squash commits bring the changes through,
Signed and ready, neat and true.
The guide now shows the way to go.

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

@hyperpolymath
hyperpolymath merged commit 0f8d210 into main Oct 1, 2026
29 of 34 checks passed
@hyperpolymath
hyperpolymath deleted the docs/signing-policy-d218 branch October 1, 2026 21:19
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