Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added pull_request_template.md #641

Merged
merged 1 commit into from
May 22, 2024
Merged

Added pull_request_template.md #641

merged 1 commit into from
May 22, 2024

Conversation

suhanipaliwal
Copy link
Contributor

Fixes #638

Signed-off-by: Suhani Singh Paliwal <[email protected]>
Copy link

vercel bot commented May 19, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
project-amupedia ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 19, 2024 7:48pm

Copy link

Thank you, @suhanipaliwal, for creating this pull request and contributing to GitHub-ReadMe! 💗

Our review team will thoroughly review the pull request and will reach out to you soon! 😇
Please make sure you have marked all the completed tasks as done. ✅
We appreciate your patience and contribution! 😀

Copy link

coderabbitai bot commented May 19, 2024

Walkthrough

Walkthrough

The newly introduced .github/pull_request_template.md file provides a standardized template for pull requests, which includes sections for related issues, a description of changes, type of PR, checklist items, and additional context. This aims to streamline the contribution process and facilitate easier review and merging by maintainers.

Changes

Files/Paths Change Summary
.github/pull_request_template.md Introduced a new PR template with sections for related issues, description of changes, type of PR, checklist, and additional context.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Add a pull request template (#638)

Poem

In the garden of code, a template blooms,
Guiding PRs through review rooms.
With sections clear and checklist tight,
Contributions shine in the brightest light.
🌸✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

@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: 6

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between c5f45df and ceb7230.
Files selected for processing (1)
  • .github/pull_request_template.md (1 hunks)

@@ -0,0 +1,26 @@
## Related Issue
Copy link

Choose a reason for hiding this comment

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

Add a blank line after the heading for better readability.

## Related Issue
+ 

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
## Related Issue
## Related Issue

## Related Issue
[Cite any related issue(s) this pull request addresses. If none, simply state “None”]

## Description
Copy link

Choose a reason for hiding this comment

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

Add a blank line after the heading for better readability.

## Description
+ 

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
## Description
## Description

- [ ] Documentation update
- [ ] Other (specify): _______________

## Screenshots / videos (if applicable)
Copy link

Choose a reason for hiding this comment

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

Add a blank line after the heading for better readability.

## Screenshots / videos (if applicable)
+ 

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
## Screenshots / videos (if applicable)
## Screenshots / videos (if applicable)

## Screenshots / videos (if applicable)
[Attach any relevant screenshots or videos demonstrating the changes]

## Checklist:
Copy link

Choose a reason for hiding this comment

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

Add a blank line after the heading for better readability.

## Checklist:
+ 

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
## Checklist:
## Checklist:

- [ ] I have commented my code, particularly in hard-to-understand areas.
<!-- [X] - put a cross/X inside [] to check the box -->

## Additional context:
Copy link

Choose a reason for hiding this comment

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

Add a blank line after the heading for better readability.

## Additional context:
+ 

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
## Additional context:
## Additional context:

[Attach any relevant screenshots or videos demonstrating the changes]

## Checklist:
- [ ] I have performed a self-review of my code
Copy link

Choose a reason for hiding this comment

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

Surround the list with blank lines for better readability.

## Checklist:
+ 
- [ ] I have performed a self-review of my code
+ 

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- [ ] I have performed a self-review of my code
## Checklist:
- [ ] I have performed a self-review of my code

@Ja3mamtora Ja3mamtora merged commit 3678be9 into amupedia2021:develop May 22, 2024
4 checks passed
@suhanipaliwal
Copy link
Contributor Author

Please add the label of gssoc and level1 on this pull request as well according to gssoc guidelines.

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.

Add PR template
2 participants