chore: add merge request template #36
Conversation
|
Warning Rate limit exceeded@shreyanshJain852 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 12 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughA new API pull request template has been introduced to guide contributors. The template, located in the repository's GitHub workflow directory, provides a checklist and structured format requiring contributors to confirm pre-requisites (such as guideline review, unit testing, and environment file updates) and to include detailed information in their pull requests. It enforces proper descriptions, formatting, and continuous integration check pass statuses before merging. Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant GitHub
participant CI
Contributor->>GitHub: Submit API pull request using new template
GitHub->>Contributor: Validate checklist completion
GitHub->>CI: Trigger continuous integration checks
CI-->>GitHub: Report test results and statuses
GitHub->>Contributor: Display CI results and pending actions
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md (4)
6-7: Improve clarity of testing requirements.The testing requirements could be more specific and grammatically correct:
-- [ ] I have performed unit testing for the new feature added or updated to ensure the new features added are working as expected. -- [ ] I have performed preliminary testing to ensure that any existing features are not impacted and any new features are working as expected as a whole. +- [ ] I have performed unit testing for the new features or updates to ensure they are working as expected. +- [ ] I have performed integration testing to ensure that existing features are not impacted, and all features work together as expected.🧰 Tools
🪛 LanguageTool
[uncategorized] ~6-~6: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...have performed unit testing for the new feature added or updated to ensure the new feat...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~7-~7: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...t any existing features are not impacted and any new features are working as expecte...(COMMA_COMPOUND_SENTENCE_2)
14-22: Improve organization of PR details checklist.Consider reorganizing the checklist to clearly separate required and optional items:
-### PR Details - -PR details have been updated as per the given format (see below) - -- [ ] PR title adheres to the format specified in guidelines (e.g., `feat: add admin login endpoint`) -- [ ] Description has been added -- [ ] Related changes have been added (optional) -- [ ] Screenshots have been added (optional) -- [ ] Query request and response examples have been added (as applicable, in case added or updated) -- [ ] Documentation changes have been listed (as applicable) -- [ ] Unit testing output is added (as applicable) -- [ ] Pending actions have been added (optional) -- [ ] Any other additional notes have been added (optional) +### PR Details + +#### Required Items +- [ ] PR title adheres to the format specified in guidelines (e.g., `feat: add admin login endpoint`) +- [ ] Description has been added +- [ ] Query request and response examples (if API changes) +- [ ] Documentation changes (if applicable) +- [ ] Unit testing output (if applicable) + +#### Optional Items +- [ ] Related changes +- [ ] Screenshots +- [ ] Pending actions +- [ ] Additional notes
29-29: Make reviewer instructions more prominent.Consider making the reviewer instructions more visible:
-_Note: Reviewer should ensure that the checklist and description have been populated and followed correctly, and the PR should be merged only after resolving all conversations and verifying that CI checks pass._ +> ⚠️ **Reviewer Instructions** +> - Ensure all required checklist items are completed +> - Verify description is populated correctly +> - Confirm all conversations are resolved +> - Check that CI pipeline passes
35-63: Enhance template sections with examples.Consider adding more specific examples to guide contributors:
**Description:** -Add brief description about the changes made in this PR and their purpose. This section can also include mention to any other PRs or issues if needed. +Add brief description about the changes made in this PR and their purpose. + +Example: +> Added a new endpoint `/api/v1/documents/{id}` to retrieve document details. This implements the requirement from issue #123. + +Related PRs/Issues: #123, #124 **Query request and response:** -- Add any query request body, cURL statement and response body for the made change or addition. +Add request/response examples for API changes: + +Example: +```bash +# Request +curl -X GET http://localhost:3000/api/v1/documents/123 + +# Response +{ + "id": "123", + "title": "Sample Document" +} +``` **Unit testing output:** -- Add the output of the status of different test cases in the unit testing performed. +Add the output of unit tests: + +Example: +``` +PASS tests/document.test.js + ✓ should return 404 for non-existent document + ✓ should return document details for valid ID + +Test Suites: 1 passed, 1 total +Tests: 2 passed, 2 total +```🧰 Tools
🪛 LanguageTool
[uncategorized] ~63-~63: You might be missing the article “a” here.
Context: ... this PR. Additional notes: - Add list of any additional notes you may want to...(AI_EN_LECTOR_MISSING_DETERMINER_A)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md
[uncategorized] ~6-~6: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...have performed unit testing for the new feature added or updated to ensure the new feat...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~7-~7: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...t any existing features are not impacted and any new features are working as expecte...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~63-~63: You might be missing the article “a” here.
Context: ... this PR. Additional notes: - Add list of any additional notes you may want to...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (csharp)
API PR Checklist
Pre-requisites
.env.examplefile with the required values as applicable.PR Details
PR details have been updated as per the given format (see below)
feat: add admin login endpoint)Additional Information
Note: Reviewer should ensure that the checklist and description have been populated and followed correctly, and the PR should be merged only after resolving all conversations and verifying that CI checks pass.
Description:
Add merge request template to the repository
Related changes:
Screenshots:
N/A
Query request and response:
N/A
Documentation changes:
N/A
Unit testing output:
N/A
Pending actions:
N/A
Additional notes:
N/A
Summary by CodeRabbit