Add Pull Request Template #573
Conversation
WalkthroughA new pull request template file, Changes
Assessment against linked issues
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🧰 Additional context used🪛 markdownlint-cli2 (0.17.2).github/PULL_REQUEST_TEMPLATE.md5-5: First line in a file should be a top-level heading (MD041, first-line-heading, first-line-h1) ⏰ Context from checks skipped due to timeout of 90000ms (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @Satyamkumarnavneet, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request introduces a standardized pull request template to the repository by adding a .github/PULL_REQUEST_TEMPLATE.md file. The template prompts contributors to provide necessary details about their changes, link related issues, and complete mandatory checks, such as testing and adding screenshots, to ensure consistency.
Highlights
- New PR Template: Adds a
.github/PULL_REQUEST_TEMPLATE.mdfile to standardize pull request submissions. - Issue Linking: The template includes a section for linking related issues using the 'Fixes' keyword.
- Checklist Inclusion: A checklist is included to ensure contributors have run pre-commit, tested their changes, and added screenshots if applicable.
Changelog
- .github/PULL_REQUEST_TEMPLATE.md
- Added a new file to define the pull request template.
- Included instructions for linking issues.
- Added a checklist for contributors to complete before submitting a pull request.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
A template's born,
Consistency takes form now,
Code reviews flow free.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a pull request template to standardize contributions. The template includes sections for linking issues, a checklist for common tasks, and a prompt for adding screenshots. This is a good step towards ensuring consistency and completeness in pull requests.
Merge Readiness
The pull request introduces a useful template that will help contributors provide necessary information. I am unable to directly approve the pull request, and recommend that others review and approve this code before merging. There are no critical or high severity issues, so this can be merged after addressing the medium and low severity issues.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/PULL_REQUEST_TEMPLATE.md
[style] ~11-~11: Consider using a different verb to strengthen your wording.
Context: ...r PR will most likely not pass — please make sure it passes pre-commit) - [ ] Did you tes...
(MAKE_SURE_ENSURE)
🪛 markdownlint-cli2 (0.17.2)
.github/PULL_REQUEST_TEMPLATE.md
4-4: First line in a file should be a top-level heading
null
(MD041, first-line-heading, first-line-h1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Run Tests
🔇 Additional comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
4-5: 💡 Verification agent🧩 Analysis chain
Replace the issue placeholder with the actual issue number
The template currently usesFixes #issue_numberas a placeholder. Be sure to update this to your real issue, for example:Fixes #540
🏁 Script executed:
#!/bin/bash # Display the first 20 lines of the PR template for review sed -n '1,20p' .github/PULL_REQUEST_TEMPLATE.mdLength of output: 726
Replace the issue placeholder with a real issue number
The PR template still includes the placeholder
Fixes #issue_number. Update it to reference the actual issue you’re closing.
- File: .github/PULL_REQUEST_TEMPLATE.md
- Lines: 4–5
Suggested change:
- <!-- Link the issue using the "Fixes" keyword. Example: Fixes #1234 --> - Fixes #issue_number + <!-- Link the issue using the "Fixes" keyword. Example: Fixes #1234 --> + Fixes #<your_issue_number>Likely an incorrect or invalid review comment.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
4-4: First line in a file should be a top-level heading
null(MD041, first-line-heading, first-line-h1)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
1-1:⚠️ Potential issueAdd a top-level heading for clarity and lint compliance
The first line should be a Markdown H1 to satisfy MD041 and improve readability.
Apply this diff to insert the title at the very top:+ # Pull Request Template +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.github/PULL_REQUEST_TEMPLATE.md
4-4: First line in a file should be a top-level heading
null
(MD041, first-line-heading, first-line-h1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Run Tests
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
1-2: 🛠️ Refactor suggestionAdd a top-level heading and a “Description” section for clarity and lint compliance
Markdown lint (MD041) expects the first line to be a top-level heading, and having a dedicated “Description” section helps contributors summarize their changes. Consider this diff:
+# Pull Request Template + <!-- Please customize the sections below to describe your changes. Pull requests that don't fill out this template may be closed without further notice. --> +## Description + +Describe the changes introduced by this pull request.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.github/PULL_REQUEST_TEMPLATE.md
4-4: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
4-4: First line in a file should be a top-level heading
null
(MD041, first-line-heading, first-line-h1)
6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Run Tests
2 participants
Fixes #540
This PR introduces a standardized Pull Request (PR) template to the repository. It ensures consistency by prompting contributors to provide necessary details about their changes, link related issues, and complete mandatory checks (like testing and adding screenshots).
Changes:
.github/pull_request_template.mdfileSummary by CodeRabbit