Skip to content
This repository was archived by the owner on Feb 17, 2025. It is now read-only.

chore: add merge request template #37

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

shreyanshJain852
Copy link
Contributor

@shreyanshJain852 shreyanshJain852 commented Feb 13, 2025

API PR Checklist

Pre-requisites

  • I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
  • 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 added/updated the .env.example file with the required values as applicable.

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)

Additional Information

  • Appropriate label(s) have been added
  • Assignee(s) and reviewer(s) have been added (optional)

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:

  • Add merge request template in the root of the repository

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

  • Documentation
    • Introduced a new checklist and structured template for API contributions to enforce consistent quality and comprehensive review, including mandatory testing and detailed submission guidelines.
    • Updated contribution guidelines now outline prerequisite steps and information standards, streamlining the review process and fostering a more robust integration process.

@shreyanshJain852 shreyanshJain852 self-assigned this Feb 13, 2025
Copy link
Contributor

coderabbitai bot commented Feb 13, 2025

Warning

Rate limit exceeded

@shreyanshJain852 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 18 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between 954e565 and 57a4c1f.

📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md (1 hunks)

Walkthrough

A new API pull request template file has been introduced to standardize and streamline API-related contributions. The template outlines prerequisites such as reviewing guidelines, performing unit tests, and updating configuration examples, and it details specific information that must be included in the pull request. It serves to ensure consistency and quality by mandating a checklist and structured description for API pull requests.

Changes

File(s) Change Summary
.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md Added a new API pull request template with a detailed checklist and instructions for required information (e.g., unit testing, documentation changes, title formatting).

Poem

I'm a rabbit hopping through the code land,
A new template in place, so neat and grand.
Checklists and guidelines make my heart sing,
With every filled box, a fresh dawn we bring.
Hopping along with bugs at bay,
I celebrate these changes in my own bunny way!


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (4)
.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md (4)

5-8: Improve clarity of testing requirements and fix grammar.

The testing requirements could be more specific, and there's a minor grammatical issue.

Apply this diff to enhance clarity:

 - [ ] I have gone through the Contributing guidelines for [Submitting a Pull Request (PR)](https://github.com/OsmosysSoftware/dotnet-foundation/blob/main/CONTRIBUTING.md#submitting-a-pull-request-pr) and ensured that this is not a duplicate PR.
-  [ ] 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 existing features are not impacted and any new features are working as expected as a whole.
+  [ ] I have performed unit testing for the new/updated features and achieved >80% code coverage.
+  [ ] I have performed integration testing to ensure that existing features are not impacted, and new features work correctly within the system.
 - [ ] I have added/updated the `.env.example` file with the required values as applicable.
🧰 Tools
🪛 LanguageTool

[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: Enhance clarity of requirements and examples.

The checklist could better distinguish between required and optional items, and provide more specific guidance for API examples.

Apply this diff to improve clarity:

-  - [ ] 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)
+  Required:
+  - [ ] PR title follows format: `<type>: <description>` (e.g., `feat: add admin login endpoint`)
+  - [ ] Description explains the purpose and impact of changes
+  - [ ] API documentation is updated with request/response schemas
+  - [ ] Unit test results show >80% coverage
+
+  Optional:
+  - [ ] Related changes or dependencies
+  - [ ] Screenshots of UI changes
+  - [ ] cURL examples for new/modified endpoints
+  - [ ] Pending tasks or follow-up work
+  - [ ] Additional context or notes

26-29: Add specific label categories for better organization.

The label guidance could be more specific to help contributors choose appropriate labels.

Apply this diff to add label categories:

-  - [ ] Appropriate label(s) have been added
+  Required labels (select at least one from each category):
+  - [ ] Type: `feature` | `bug` | `enhancement` | `documentation` | `refactor`
+  - [ ] Priority: `high` | `medium` | `low`
+  - [ ] Status: `ready-for-review` | `in-progress` | `blocked`
   - [ ] Assignee(s) and reviewer(s) have been added (optional)

45-48: Add structured format for API examples.

The query request and response section would benefit from a more structured format.

Apply this diff to add a structured format:

 **Query request and response:**
 
-  - Add any query request body, cURL statement and response body for the made change or addition.
+  For each modified endpoint, provide:
+  ```
+  ### Endpoint: [GET/POST/PUT/DELETE] /api/path
+  
+  Request:
+  ```curl
+  curl -X POST 'http://api/endpoint' \
+    -H 'Content-Type: application/json' \
+    -d '{
+      "key": "value"
+    }'
+  ```
+  
+  Response (200 OK):
+  ```json
+  {
+    "key": "value"
+  }
+  ```
+  
+  Error Response (4xx/5xx):
+  ```json
+  {
+    "error": "description"
+  }
+  ```
+  ```
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 83abafe and 954e565.

📒 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] ~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)

🔇 Additional comments (1)
.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md (1)

1-64: Well-structured template that will improve PR quality!

The template provides a comprehensive framework for API-related PRs, covering essential aspects like testing, documentation, and examples. The suggested improvements above would enhance clarity and structure, but the current version is already valuable for standardizing contributions.

🧰 Tools
🪛 LanguageTool

[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)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant