Skip to content

docs: add Signed commits section to CONTRIBUTING - #111

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: 743f71e8-f5bb-4824-94f4-356f0d12d96e

📥 Commits

Reviewing files that changed from the base of the PR and between 9df7a29 and f4373ab.

📒 Files selected for processing (2)
  • .github/CONTRIBUTING.md
  • CONTRIBUTING.adoc

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. (10)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: Rust Workspace
  • GitHub Check: Security Checks
  • GitHub Check: Haskell Analyzer
  • GitHub Check: Analyze (rust)
  • GitHub Check: Analyze (actions)
🔇 Additional comments (2)
.github/CONTRIBUTING.md (1)

28-44: LGTM!

CONTRIBUTING.adoc (1)

59-75: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidance to require signed commits for changes reaching the default branch. People and interactive agents must use a GitHub-registered SSH signing key and verified committer email; apps, bots and workflows must use GitHub’s API or the approved signed-push action.
    • Contributors must squash-merge pull requests. Unsigned commits on a pull request branch prevent merging, and rebase merging is no longer available.

Walkthrough

The two contribution guides now document signed-commit requirements, signing methods for people and automation, and squash-only merging. They also describe the effect of unsigned commits on pull requests and how to address them.

Changes

Signed Commit Contribution Guidance

Layer / File(s) Summary
Document signed-commit requirements
.github/CONTRIBUTING.md, CONTRIBUTING.adoc
Both guides specify SSH signing with a GitHub-registered key and verified committer email for people and interactive agents. They direct apps, bots and workflows to use the GitHub API or signed-push action. They state that unsigned commits block merging, require squash merges and note that rebase merging is disabled.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to f4373

The guidance aligns with the estate policy, and no specific documentation defect is established. The repository’s actual GitHub enforcement settings remain unconfirmed; no concrete merge-blocking risk was identified.

Architecture Summary

Architecture risk: 🔵 Low · up to f4373

The change affects 1 system.

Changed systems: CONTRIBUTING.adoc

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — CONTRIBUTING.adoc (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in CONTRIBUTING.adoc: Added signed-commit requirements, including SSH signing configuration and verified committer email for people and interactive agents, API-based commits for apps, bots and workflows, and squash-only PR merging. Unsigned commits on a PR branch block merging; affected branches must be recreated with signed commits, and rebase-merge is disabled.
  • observed — Modified behavior in .github/CONTRIBUTING.md: Adds signing instructions requiring signed commits on the default branch, specifying SSH signing setup and verified committer email for people and interactive agents, API-based commits for apps, bots and workflows, and squash merges. It states that unsigned commits on a PR branch block merging, gives a signed cherry-pick and new-PR remedy, 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 changes, signing policy, SSH requirements, merge method, and scope.
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 hops through guidance, neat and clear.
The bots use APIs to write,
While squash keeps branches tidy, right.
No unsigned commits pass the gate.

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