Skip to content

chore: restructure of the PR template - #37

Merged
dagardner-nv merged 2 commits into
NVIDIA:mainfrom
dagardner-nv:david-pr-template
Jul 7, 2026
Merged

chore: restructure of the PR template#37
dagardner-nv merged 2 commits into
NVIDIA:mainfrom
dagardner-nv:david-pr-template

Conversation

@dagardner-nv

@dagardner-nv dagardner-nv commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

Overview

  • Combine overview and details sections
  • Move check boxes to the bottom
  • I confirm this contribution is my own work, or I have the right to submit it under this project's license.
  • I searched existing issues and open pull requests, and this does not duplicate existing work.

Summary by CodeRabbit

  • Documentation
    • Simplified the pull request template with clearer guidance for authors.
    • Moved checklist items closer to the related issues section for a smoother flow.
    • Removed extra prompt text and replaced it with a shorter placeholder for describing changes.

Signed-off-by: David Gardner <dagardner@nvidia.com>
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: a22fdf63-c418-48c9-ba48-dc2bcdbf9e39

📥 Commits

Reviewing files that changed from the base of the PR and between 78cb1cf and 340b48f.

📒 Files selected for processing (1)
  • .github/pull_request_template.md
📜 Recent review details
🔇 Additional comments (1)
.github/pull_request_template.md (1)

3-4: LGTM!

Also applies to: 13-14


Walkthrough

The pull request template was updated to replace the opening description guidance and details section with an HTML comment prompt, and to move two checklist items later in the template after the related-issues placeholder.

Changes

PR Template Update

Layer / File(s) Summary
Restructure PR template content and checklist order
.github/pull_request_template.md
Replaced the initial description/details content with an HTML comment prompt and moved the ownership and duplicate-check checklist items after the related-issues placeholder.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description includes Overview and checklist items, but it omits Details, reviewer start guidance, and Related Issues. Add the missing Details, Where should the reviewer start?, and Related Issues sections, and ensure the checklist matches the template order.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the PR’s main change and follows Conventional Commits with a valid chore prefix.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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.

Inline comments:
In @.github/pull_request_template.md:
- Line 14: The pull request template is missing a final trailing newline, which
keeps markdownlint warnings active. Update the .github pull_request_template.md
content so it ends with exactly one newline after the last line; this is a
formatting-only fix and should not change any checklist text or structure.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: fc30c105-41e2-459e-94eb-7c1a3241d56c

📥 Commits

Reviewing files that changed from the base of the PR and between 3613635 and 78cb1cf.

📒 Files selected for processing (1)
  • .github/pull_request_template.md
📜 Review details
🧰 Additional context used
🪛 markdownlint-cli2 (0.22.1)
.github/pull_request_template.md

[warning] 14-14: Files should end with a single newline character

(MD047, single-trailing-newline)

🔇 Additional comments (1)
.github/pull_request_template.md (1)

3-4: LGTM!

Comment thread .github/pull_request_template.md Outdated
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

Signed-off-by: David Gardner <dagardner@nvidia.com>
@dagardner-nv
dagardner-nv merged commit 08e6556 into NVIDIA:main Jul 7, 2026
5 checks passed
@dagardner-nv
dagardner-nv deleted the david-pr-template branch July 7, 2026 18:17
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