Repository navigation
docs: add DCO sign-off to PR template - #341
Merged
Merged
Conversation
Signed-off-by: Ajay Thorve <athorve@nvidia.com>
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📜 Recent review details⏰ Context from checks skipped due to timeout. (2)
🧰 Additional context used📓 Path-based instructions (1){.github/**,ci/**,.pre-commit-config.yaml,pyproject.toml,uv.lock}⚙️ CodeRabbit configuration file
Files:
🔇 Additional comments (1)
WalkthroughThe pull request template now includes squash-commit DCO sign-off instructions, a required ChangesDCO sign-off workflow
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
AjayThorve
marked this pull request as ready for review
July 15, 2026 19:17
Member
Author
|
/merge |
tanleach
approved these changes
Jul 15, 2026
6 tasks done
rapids-bot Bot
pushed a commit
that referenced
this pull request
Jul 15, 2026
#### Overview Clarify that angle brackets around the email address are required syntax in the DCO `Signed-off-by` trailer copied into squash commits. The existing template showed the canonical form but did not explicitly identify the brackets as syntax. Contributors could therefore remove them while replacing the placeholder and produce a malformed trailer. This update adds an exact valid example and makes preserving the brackets part of the checklist. #### DCO sign-off for the squash commit Signed-off-by: Ajay Thorve <athorve@nvidia.com> #### Validation - [x] I ran the relevant local checks or explained why they are not applicable. - `pre-commit run --files .github/pull_request_template.md` passed all applicable hooks, including Markdown Link Check and Detect secrets. - [x] I added or updated tests for behavior changes. - Not applicable: this PR changes only contributor-facing Markdown and has no runtime behavior. - [x] I updated documentation for user-facing or contributor-facing changes. - [x] I confirmed this PR does not include secrets, credentials, or internal-only data. - [x] I certify this contribution under the Developer Certificate of Origin (DCO) and signed my commits with `git commit -s` or an equivalent sign-off. - [x] I replaced the DCO sign-off placeholder above with the identity GitHub will use for the squash commit and kept the required angle brackets around the email address. #### Where should reviewers start? Review `.github/pull_request_template.md`; it is the only changed file. #### Related Issues - Relates to #341 ## Summary by CodeRabbit * **Documentation** * Updated pull request sign-off instructions to require angle brackets around email addresses. * Clarified the validation checklist for replacing placeholder identity details in squash commits. Authors: - Ajay Thorve (https://github.com/AjayThorve) Approvers: - Kyle Zheng (https://github.com/KyleZheng1284) URL: #348
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Adds an explicit DCO sign-off field to the pull request template for repositories using the RAPIDS squash auto-merger.
The auto-merger copies the PR description into the generated squash commit. Without a matching
Signed-off-bytrailer in that description, the generated release commit fails DCO when it is subsequently forward-merged intodevelop.The template directs contributors to use the commit identity configured by GitHub, including the GitHub-provided noreply address when email privacy is enabled.
DCO sign-off for the squash commit
Signed-off-by: Ajay Thorve AjayThorve@users.noreply.github.com
Validation
git diff --checkuv run pre-commit run --files .github/pull_request_template.mdWhere should reviewers start?
Review
.github/pull_request_template.mdand confirm that the sign-off instructions match the identity GitHub assigns to generated squash commits.Related Issues
This is a process workaround for DCO failures on automated
release/2.2todevelopforward merges.Summary by CodeRabbit