docs: add template for Pull Request

[derianrddev]

Pull Request Overview

📝 Summary

• Closes Add Template for Pull Request  #106

🔄 Changes Made

• Create the .github folder in the root of the repository.
• Add the template within that folder with the parts described in the issue.

Summary by CodeRabbit

• New Features
  • Introduced a standardized pull request template to enhance clarity and communication during the pull request process.
  • Template includes sections for summarizing changes, related issues, types of modifications, and implementation details.

[coderabbitai]

Walkthrough

This pull request introduces a new pull request template for GitHub repositories, aimed at standardizing the information provided in pull requests. The template is structured to include several key sections: a summary of the pull request, related issues, types of changes, and detailed descriptions of modifications made. Contributors are prompted to specify the nature of their changes, such as whether they involve documentation updates, bug fixes, enhancements, or breaking changes. Additional sections are included for implementation details, technical notes, test results, test coverage, evidence of testing, and next steps. This structured format is intended to enhance communication and documentation throughout the pull request process.

Assessment against linked issues

Objective	Addressed	Explanation
Include a summary of the pull request	✅
Specify changes made	✅
Include test results	❌	Test results section is not explicitly mentioned.
Outline next steps	✅

Suggested labels

documentation, internal-contributor

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4245d36 and f72fbdc.

📒 Files selected for processing (1)

• .github/PULL_REQUEST_TEMPLATE.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

.github/PULL_REQUEST_TEMPLATE.md

[style] ~12-~12: Consider using a different verb for a more formal wording.
Context: ...] 🐛 Bug fix (non-breaking change which fixes an issue) - [ ] 👌 Enhancement (non-bre...

(FIX_RESOLVE)

---

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>, 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 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.

[coderabbitai]

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (1)

.github/pull_request_template.md (1)

1-2: Consider adding a brief introduction to the template.

Adding a short description would help contributors understand how to use this template effectively.

 # Pull Request Overview
+
+<!-- 
+Please fill out this template to help reviewers understand your changes.
+Remove any sections that are not applicable to your PR.
+-->

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 09fecd0 and 4245d36.

📒 Files selected for processing (1)

• .github/pull_request_template.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

.github/pull_request_template.md

[typographical] ~6-~6: Consider adding a comma here.
Context: ...ry - Closes #(issue) ## 🔄 Changes Made Please provide a general description of your c...

(PLEASE_COMMA)

[jimenezz22]

@derianrddev please apply the changes suggested by CodeRabbit and also change the file name to PULL_REQUEST_TEMPLATE.md