Skip to content

[SVLS-10001] docs: add CONTRIBUTING.md with commit signing steps - #1488

Open
lym953 wants to merge 1 commit into
mainfrom
yiming.luo/contributing-signed-commits
Open

lym953 wants to merge 1 commit into
mainfrom
yiming.luo/contributing-signed-commits

Conversation

@lym953

@lym953 lym953 commented Nov 2, 2026

Copy link
Copy Markdown
Collaborator

Problem

GitHub blocks the merge of a pull request into main until every commit has a verified signature. An organization ruleset sets this requirement. External contributors often push unsigned commits, and the repository has no guide that tells them to sign. A maintainer then has to sign the commits again and push to the contributor's fork. This happened on #1431.

This PR

  • Adds CONTRIBUTING.md with three sections:
    • Sign your commits: how to set up a GPG or SSH signing key, and a command that signs commits again after a push.
    • Open the pull request: use the template, and keep Allow edits by maintainers selected. Then a maintainer can sign the commits again.
    • Run the checks: the format, lint and test commands that CI runs.
  • Links the guide from the Contributing section of the README.

The signing section follows the "Sign your commits" section in the dd-trace-js contributing guide. The check commands come from the Rust CI workflow, .github/workflows/rs_ci.yml.

Testing

Steps

  1. In a scratch repository with an upstream remote, made two unsigned commits on a branch.
  2. Ran the command from the guide: git rebase --exec 'git commit --amend --no-edit -n -S' $(git merge-base HEAD upstream/main).
  3. Opened the GitHub signing documentation link from the guide.

Result

Check Before After
Signature status of the two branch commits (git log %G?) N, no signature G, good signature
Base commit N N, unchanged
GitHub signing documentation link Not applicable HTTP 200

I did not run the three check commands for this PR, because it changes no code.

🤖 Generated with Claude Code

GitHub blocks the merge until every commit has a verified signature, and
external contributors often push unsigned commits. The guide tells them
how to sign, how to sign pushed commits again, and to keep "Allow edits
by maintainers" selected. The README links to it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@lym953
lym953 marked this pull request as ready for review November 2, 2026 20:16
Copilot AI balanced review requested due to automatic review settings November 2, 2026 20:16
@lym953
lym953 requested a review from a team as a code owner November 2, 2026 20:16
@lym953
lym953 requested a review from clifordshelton November 2, 2026 20:16
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-02T20:17:39.293269Z 188b2fb Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues block the contribution guidance and README link updates.

No open issues 🎉

What changed in this PR

Adds contribution guidance for the Datadog Lambda Extension to help contributors meet verified-signature requirements and prepare pull requests.

Changes:

  • Documents commit-signing setup and how to re-sign previously pushed commits.
  • Explains pull request expectations and lists Rust check commands.
  • Links the new guide from the README.
File Description
README.md Links to repository-specific contribution requirements.
CONTRIBUTING.md Adds signing instructions, pull request guidance, and check commands.

Review effort: Balanced

@datadog-datadog-prod-us1-2

datadog-datadog-prod-us1-2 Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Pipelines

❌ Errors

Your PR has failed checks. Please review the issues below and take necessary action before merging.

🚦 3 Pipeline jobs failed

DDCI - DataDog/datadog-lambda-extension | e2e-test-status (amd64) — 🔄 Retry may pass, looks flaky

View more details · View in DDCI

DataDog/datadog-lambda-extension | bottlecap (arm64, fips, alpine) — 🔄 Retry may pass, looks flaky

View more details · View in GitLab

DataDog/datadog-lambda-extension | e2e-test-status (amd64) — 🔄 Retry may pass, looks flaky

View more details · View in GitLab

Useful? React with 👍 / 👎

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 188b2fb | Docs | View more details | Give us feedback!

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.

2 participants