chore: add pull request template#267
Conversation
WalkthroughA new GitHub pull request template is added at ChangesPull Request Template
🚥 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)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
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 1: The pull request template file begins with a level-2 heading (`##
Description`) but GitHub PR templates should conventionally start with a level-1
heading. Change the first line from `## Description` to `# Description` to use
the correct heading hierarchy for the template 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: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 26db78bc-750f-4a81-804b-5f6c59e04d4a
📒 Files selected for processing (1)
.github/pull_request_template.md
| @@ -0,0 +1,39 @@ | |||
| ## Description | |||
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
File should start with a top-level heading (#) rather than level-2 heading (##).
GitHub PR templates conventionally begin with a level-1 heading. Update line 1 to use # PR Title or similar, or restructure the template hierarchy accordingly.
📝 Proposed fix
-## Description
-<!-- What does this PR do? -->
+# Pull Request
+
+## Description
+<!-- What does this PR do? -->🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 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 at line 1, The pull request template file
begins with a level-2 heading (`## Description`) but GitHub PR templates should
conventionally start with a level-1 heading. Change the first line from `##
Description` to `# Description` to use the correct heading hierarchy for the
template structure.
Source: Linters/SAST tools
Adds a PR template based on the any-llm project template, with the contribution guidelines link pointing to this repo.
Summary by CodeRabbit