docs(contributor): streamline create-pr verification - #5396
Merged
Conversation
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-5396.docs.buildwithfern.com/nemoclaw |
Contributor
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
Contributor
Vitest E2E Scenario RecommendationRequired Vitest E2E scenarios: None Full Vitest E2E advisor summaryVitest E2E Scenario AdvisorBase: Required Vitest E2E scenarios
Optional Vitest E2E scenarios
Relevant changed files
|
Contributor
📝 WalkthroughWalkthroughThis PR updates contributor guidance across six documentation files to streamline PR verification workflows. The changes consolidate around Git hooks (pre-commit, commit-msg, pre-push) as the primary verification mechanism, with a narrower diff-scoped fallback command ( ChangesPR Verification Workflow Guidance
Possibly Related PRs
Suggested Labels
Estimated Code Review Effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
PR Review AdvisorFindings: 0 needs attention, 0 worth checking, 0 nice ideas This is an automated advisory review. A human maintainer must make the final merge decision. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.agents/skills/nemoclaw-contributor-create-pr/SKILL.md (1)
1-4:⚠️ Potential issue | 🔴 Critical | ⚡ Quick winMissing SPDX license header.
The file must include an SPDX license header in HTML comments after the YAML frontmatter. Per coding guidelines, every
.mdfile requires the header.🛡️ Proposed fix
--- name: nemoclaw-contributor-create-pr description: Create GitHub pull requests that follow the NemoClaw PR template. Use when the user wants to create a new PR, submit code for review, open a pull request, or push changes for review. Trigger keywords - create PR, pull request, new PR, submit for review, open PR, push for review. --- + +<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. --> +<!-- SPDX-License-Identifier: Apache-2.0 --> # Create GitHub Pull Request🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.agents/skills/nemoclaw-contributor-create-pr/SKILL.md around lines 1 - 4, Add an SPDX license header as an HTML comment immediately after the YAML frontmatter in the .md file; in nemoclaw-contributor-create-pr/SKILL.md insert a line like <!-- SPDX-License-Identifier: <LICENSE-ID> --> (replacing <LICENSE-ID> with the project's chosen SPDX identifier) on the first line after the closing --- so the file has the required SPDX header.Source: Coding guidelines
🧹 Nitpick comments (2)
.github/PULL_REQUEST_TEMPLATE.md (1)
1-2: 💤 Low valueAdd SPDX license header for consistency.
For consistency with other markdown files in the root (AGENTS.md, CONTRIBUTING.md), add an SPDX header comment before the template content.
💡 Proposed fix
+<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. --> +<!-- SPDX-License-Identifier: Apache-2.0 --> <!-- markdownlint-disable MD041 -->🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/PULL_REQUEST_TEMPLATE.md around lines 1 - 2, Add an SPDX license header comment at the top of the pull request template by inserting a single-line SPDX identifier (e.g., <!-- SPDX-License-Identifier: MIT -->) immediately before the existing markdown content so the template matches other root markdown files; update .github/PULL_REQUEST_TEMPLATE.md by placing the SPDX comment above the existing "<!-- markdownlint-disable MD041 -->" line..agents/skills/nemoclaw-contributor-create-pr/SKILL.md (1)
222-224: 💤 Low valueReduce repetition of "Do not" at sentence starts.
Three successive sentences begin with "Do not," which LanguageTool flags as repetitive. Consider restructuring one or two to improve flow.
💡 Suggested refactoring
- **Do not rerun hook-covered checks by default.** Normal commit and push hooks are valid verification. Use `npx prek run --from-ref main --to-ref HEAD` as the fallback when hooks were skipped, missing, or uncertain. -- **Do not run the full test suite for doc-only changes by default.** Run the docs build instead, and leave `npm test` unchecked unless you actually ran it. +- **For doc-only changes, skip the full test suite by default.** Run the docs build instead, and leave `npm test` unchecked unless you actually ran it.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.agents/skills/nemoclaw-contributor-create-pr/SKILL.md around lines 222 - 224, Reword the three consecutive bullets that each start with "Do not" to reduce repetition: change "Do not rerun hook-covered checks by default. Normal commit and push hooks are valid verification. Use `npx prek run --from-ref main --to-ref HEAD` as the fallback when hooks were skipped, missing, or uncertain." into a positive/neutral phrasing like "Avoid rerunning hook-covered checks by default; use `npx prek run --from-ref main --to-ref HEAD` only when hooks were skipped, missing, or uncertain," change "Do not run the full test suite for doc-only changes by default. Run the docs build instead, and leave `npm test` unchecked unless you actually ran it." into "For doc-only changes, run the docs build instead of the full test suite and leave `npm test` unchecked unless you actually ran it," and change "Do not forget the DCO sign-off. CI will reject the PR without it." into "Remember to include the DCO sign-off; CI will reject the PR without it." Update the three list items accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In @.agents/skills/nemoclaw-contributor-create-pr/SKILL.md:
- Around line 1-4: Add an SPDX license header as an HTML comment immediately
after the YAML frontmatter in the .md file; in
nemoclaw-contributor-create-pr/SKILL.md insert a line like <!--
SPDX-License-Identifier: <LICENSE-ID> --> (replacing <LICENSE-ID> with the
project's chosen SPDX identifier) on the first line after the closing --- so the
file has the required SPDX header.
---
Nitpick comments:
In @.agents/skills/nemoclaw-contributor-create-pr/SKILL.md:
- Around line 222-224: Reword the three consecutive bullets that each start with
"Do not" to reduce repetition: change "Do not rerun hook-covered checks by
default. Normal commit and push hooks are valid verification. Use `npx prek run
--from-ref main --to-ref HEAD` as the fallback when hooks were skipped, missing,
or uncertain." into a positive/neutral phrasing like "Avoid rerunning
hook-covered checks by default; use `npx prek run --from-ref main --to-ref HEAD`
only when hooks were skipped, missing, or uncertain," change "Do not run the
full test suite for doc-only changes by default. Run the docs build instead, and
leave `npm test` unchecked unless you actually ran it." into "For doc-only
changes, run the docs build instead of the full test suite and leave `npm test`
unchecked unless you actually ran it," and change "Do not forget the DCO
sign-off. CI will reject the PR without it." into "Remember to include the DCO
sign-off; CI will reject the PR without it." Update the three list items
accordingly.
In @.github/PULL_REQUEST_TEMPLATE.md:
- Around line 1-2: Add an SPDX license header comment at the top of the pull
request template by inserting a single-line SPDX identifier (e.g., <!--
SPDX-License-Identifier: MIT -->) immediately before the existing markdown
content so the template matches other root markdown files; update
.github/PULL_REQUEST_TEMPLATE.md by placing the SPDX comment above the existing
"<!-- markdownlint-disable MD041 -->" line.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: d9a1a01c-8087-444a-b995-5aa4fe70c8ff
📒 Files selected for processing (6)
.agents/skills/nemoclaw-contributor-create-pr/SKILL.md.github/PULL_REQUEST_TEMPLATE.mdAGENTS.mdCONTRIBUTING.mddocs/AGENTS.mddocs/CONTRIBUTING.md
14 tasks
wscurran
added
area: docs
23 tasks
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
2 participants
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.
Summary
Streamline the NemoClaw create-PR workflow so normal commit and push hooks count as verification instead of requiring duplicate full local gates. The updated guidance prefers diff-scoped hook fallback and targeted tests, while preserving docs-build requirements for documentation changes.
Changes
nemoclaw-contributor-create-prskill to treat normal Git hook success as PR verification and usenpx prek run --from-ref main --to-ref HEADonly as a fallback.npm testruns.AGENTS.md,CONTRIBUTING.md,docs/AGENTS.md, anddocs/CONTRIBUTING.md, with the efficient PR process.Type of Change
Verification
npx prek run --from-ref main --to-ref HEADpassesnpm testpasses (broad runtime changes only)npm run docsbuilds without warnings (doc changes only)Signed-off-by: Carlos Villela cvillela@nvidia.com
Summary by CodeRabbit