Add PULL_REQUEST_TEMPLATE.md to the repository

[dylanpulver]

Description

This PR introduces a PULL_REQUEST_TEMPLATE.md file to the repository, located in the .github directory. The template is designed to streamline the process of creating pull requests by prompting contributors to provide essential information, such as the type of change, related issues, testing steps, and a checklist for ensuring quality.

Changes

• Added PULL_REQUEST_TEMPLATE.md to the .github directory.

Purpose

The template aims to make the pull request process more consistent and efficient, providing useful prompts for contributors while keeping things simple and manageable.

Checklist

• Template added to .github directory
• Verified that the template will be used for new PRs

Summary by CodeRabbit

• New Features
  • Introduced a standardized pull request template to enhance clarity and consistency for contributors.
  • The template includes sections for change descriptions, types of changes, related issues, testing information, and a checklist for quality assurance.

[coderabbitai]

Walkthrough

This pull request introduces a new pull request template located in .github/PULL_REQUEST_TEMPLATE.md. The template is structured to standardize the information provided by contributors, including sections for a description of changes, type of change, related issues, testing information, a checklist for code quality and documentation, and additional notes for reviewers. This aims to ensure that all necessary details are included for effective review and integration.

Changes

File	Change Summary
.github/PULL_REQUEST_TEMPLATE.md	Added a new pull request template with sections for change description, type, related issues, testing info, checklist, and notes for reviewers.

Poem

In the meadow where bunnies play,
A template blooms, brightening the day.
With sections neat, it guides the way,
For every change that comes our way.
Hops of joy, let’s cheer and say,
"Review with ease, hip-hip-hooray!" 🐇✨

Tip

OpenAI O1 model for chat

• We have deployed OpenAI's latest O1 model for chat.
• OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
• Please share any feedback with us in the discussions post.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 15e757c and 5ef29d2.

Files selected for processing (1)

• .github/PULL_REQUEST_TEMPLATE.md (1 hunks)

Additional comments not posted (6)

.github/PULL_REQUEST_TEMPLATE.md (6)

1-4: LGTM!

The "Description" section is well-structured and provides clear instructions to the user to briefly describe the purpose of the pull request, the changes introduced, and the reason for the changes.

---

5-11: LGTM!

The "Type of Change" section covers the most common types of changes and provides an option for other types of changes. This helps categorize the pull request and provides a quick overview of the type of change.

---

13-16: LGTM!

The "Related Issues" section provides clear instructions to the user to list any related issues or reference other pull requests. The example helps the user understand how to reference issues.

---

17-23: LGTM!

The "Testing" section provides clear instructions to the user to indicate if tests were added or updated, or if no tests are required. It also prompts the user to briefly describe the testing that was done, which helps the reviewer understand the testing coverage.

---

24-29: LGTM!

The "Checklist" section provides a comprehensive checklist to ensure that the code meets the required standards. It helps the user ensure that the code is well-documented, the changelog is updated (if needed), no sensitive information is included in the code, and all PR feedback is addressed.

---

31-33: LGTM!

The "Additional Notes" section provides an opportunity for the user to provide any additional notes or comments to help the reviewer. This can be useful for providing context or clarifying any questions that the reviewer may have.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.
  • @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 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.