Skip to content

docs: require signed commits#11873

Open
Copilot wants to merge 5 commits into
mainfrom
copilot/update-contributing-docs-sign-commits
Open

docs: require signed commits#11873
Copilot wants to merge 5 commits into
mainfrom
copilot/update-contributing-docs-sign-commits

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 13, 2026

Description

Contributor docs only mentioned the DCO Signed-off-by line and never told contributors to cryptographically sign commits. Adds the missing guidance, written once and linked from related docs.

  • first-commit-06-creating-a-pr/index.md: New "Signing your commits" section — calls out that signing is separate from Signed-off-by, lists the three supported formats (GPG / SSH / S/MIME), links to the four relevant GitHub docs, and shows the git config --global commit.gpgsign true one-liner.
  • contributing-pull-requests/README.md: "Signing your commits" section is a one-line pointer to the canonical section above — no duplicated prose.

Type of change

  • This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).

Contributor checklist

Please verify that the PR meets the following requirements, where applicable:

  • An overview of proposed schema changes is included in a linked GitHub issue.
    • Yes
    • Not applicable
  • A design document is added or updated under eng/design-notes/ in this repository, if new APIs are being introduced.
    • Yes
    • Not applicable
  • The design document has been reviewed and approved by Radius maintainers/approvers.
    • Yes
    • Not applicable
  • A PR for resource-types-contrib is created, if resource types or recipes are affected by the changes in this PR.
    • Yes
    • Not applicable
  • A PR for dashboard is created, if the Radius Dashboard is affected by the changes in this PR.
    • Yes
    • Not applicable
  • A PR for the documentation repository is created, if the changes in this PR affect the documentation or any user facing updates are made.
    • Yes
    • Not applicable

Copilot AI and others added 3 commits May 13, 2026 13:19
Agent-Logs-Url: https://github.com/radius-project/radius/sessions/c9b37b66-e362-434e-8783-7d523ebf5da6

Co-authored-by: brooke-hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Agent-Logs-Url: https://github.com/radius-project/radius/sessions/43578fa1-b891-4de7-9e28-c810db816bf9

Co-authored-by: brooke-hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Agent-Logs-Url: https://github.com/radius-project/radius/sessions/3db4b784-39c5-4544-94cf-9f9389c43ec6

Co-authored-by: brooke-hamilton <45323234+brooke-hamilton@users.noreply.github.com>
@brooke-hamilton brooke-hamilton marked this pull request as ready for review May 13, 2026 14:00
@brooke-hamilton brooke-hamilton requested review from a team as code owners May 13, 2026 14:00
Copilot AI review requested due to automatic review settings May 13, 2026 14:00
@brooke-hamilton brooke-hamilton changed the title docs: require signed commits and consolidate guidance docs: require signed commits May 13, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 13, 2026

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the contributor documentation to explicitly require cryptographic commit signing (separate from DCO sign-off), centralizing the guidance in the “first commit” guide and linking to it from the PR guidelines to avoid duplicated instructions.

Changes:

  • Add a new “Signing your commits” section to the first-commit PR-creation guide, including supported signature types and links to GitHub’s official docs.
  • Add a short pointer section in the pull request contributing guide that links to the canonical signing instructions.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/contributing/contributing-pull-requests/README.md Adds a “Signing your commits” section that links to the canonical guidance.
docs/contributing/contributing-code/contributing-code-first-commit/first-commit-06-creating-a-pr/index.md Adds the canonical commit-signing guidance, references, and a git config one-liner.

brooke-hamilton and others added 2 commits May 13, 2026 13:05
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants