Skip to content

docs: add Signed commits section to CONTRIBUTING #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hyperpolymath merged 3 commits into from
Oct 1, 2026
Merged

docs: add Signed commits section to CONTRIBUTING #179

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d378063
docs: add Signed commits section to CONTRIBUTING
hyperpolymath Sep 30, 2026
a9b68f5
docs: correct Signed commits section
hyperpolymath Sep 30, 2026
cf8f584
docs: align Signed commits section with SSH-for-people and heading level
hyperpolymath Sep 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,20 @@ Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
## License

Contributions licensed under project license.

## Signed commits

Every commit that reaches the default branch must be signed; a ruleset refuses
unsigned pushes. Estate policy:
[SIGNING-POLICY](https://github.com/hyperpolymath/standards/blob/main/docs/SIGNING-POLICY.adoc).

- **People and interactive agents** sign with an SSH key registered on GitHub
as a *signing* key (`gpg.format=ssh`, `user.signingkey=<key>.pub`,
`commit.gpgsign=true`). The committer email must be verified on that account.
- **Apps, bots and workflows** never `git push` local commits. They write
through the API (`createCommitOnBranch` or the estate `signed-push` action)
so that GitHub signs each commit.
- Merge PRs with **squash**. The ruleset checks every commit on the PR branch,
not just the result, so one unsigned commit blocks the merge. Re-create such a
branch with signed commits (`git cherry-pick -S`) and open a new PR.
Rebase-merge replays commits unsigned and is disabled.
Loading