Add pull request template for improved contribution process

[guibranco]

Description

• Introduced a structured pull request template to improve contribution process.
• The template includes sections for description, checks, and additional information.
• Encourages contributors to adhere to project standards and document changes effectively.

---

Changes walkthrough 📝

	Relevant files
Documentation	pull_request_template.md Add pull request template for better contribution guidelines pull_request_template.md Added a new pull request template. Included sections for description, checks, and additional information. Provided guidance for contributors on submitting pull requests. +31/-0

Summary by CodeRabbit

• New Features
  • Introduced a standardized pull request template to enhance clarity and consistency in submissions.
  • Included sections for closing issues, describing changes, and confirming adherence to project standards.
  • Added a checklist for contributors to ensure compliance with code style, documentation, and testing.
  • Encouraged smaller, focused pull requests over larger ones for better manageability.

[penify-dev]

PR Review 🔍

⏱️ Estimated effort to review [1-5]	1, because the changes are straightforward and consist of adding a template without complex logic or functionality.
🧪 Relevant tests	No
⚡ Possible issues	No
🔒 Security concerns	No

[coderabbitai]

Warning

Rate limit exceeded

@guibranco has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 4 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

Files that changed from the base of the PR and between 9b58579 and 4ebb4e9.

Walkthrough

This pull request introduces a new Markdown pull request template to standardize the submission process for contributors. The template includes sections for closing issues, describing changes, and ensuring compliance with project standards. It promotes the submission of smaller, focused pull requests and features a checklist for contributors to confirm adherence to coding standards, documentation updates, and test statuses. The template also requests information on breaking changes and any additional relevant details.

Changes

File	Change Summary
.github/pull_request_template.md	Added a new pull request template in Markdown format.

Poem

In the code where rabbits play,
A template hops in, bright and gay.
With checklists and sections, oh so neat,
Helping our pull requests be a treat!
Smaller changes, clear and bright,
Together we code, in joyful delight! 🐇✨

---

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 generate interesting stats about this repository and render them as a table.
  -- @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.

[penify-dev]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Add a motivation section to enhance understanding of the PR's purpose Consider adding a section for contributors to provide context on the motivation behind their changes, which can help reviewers understand the purpose of the PR better. pull_request_template.md [10-11] ## 📑 Description <!-- Add a brief description of the pr --> +## 📝 Motivation +<!-- Provide context on the motivation behind the changes --> + Suggestion importance[1-10]: 8 Why: Adding a motivation section enhances the understanding of the PR's purpose, which is valuable for reviewers.	8
	Introduce a section for related issues or pull requests to improve traceability It may be beneficial to include a section for contributors to list any related issues or pull requests, which can improve traceability and context. pull_request_template.md [30-31] ## ℹ Additional Information <!-- Any additional information like breaking changes, dependencies added, screenshots, comparisons between new and old behavior, etc. --> +## 🔗 Related Issues/PRs +<!-- List any related issues or pull requests --> + Suggestion importance[1-10]: 8 Why: Including a section for related issues or PRs improves traceability and provides context, which is important for effective review.	8
Best practice	Rephrase checklist items to be more action-oriented for better clarity Consider rephrasing the checklist items to be more action-oriented, which can help contributors focus on what they need to do. pull_request_template.md [20] -- [ ] My pull request adheres to the code style of this project +- [ ] Ensure my pull request adheres to the code style of this project Suggestion importance[1-10]: 7 Why: Rephrasing checklist items to be action-oriented enhances clarity and encourages contributors to take specific actions.	7
	Add a reminder to squash commits before merging for a cleaner commit history It might be useful to add a reminder for contributors to squash commits before merging, which can help maintain a clean commit history. pull_request_template.md [26] <!-- If this introduces a breaking change, make sure to note it here and what the impact might be --> +<!-- Remember to squash commits before merging to keep the commit history clean --> + Suggestion importance[1-10]: 6 Why: Adding a reminder to squash commits before merging is a good practice for maintaining a clean commit history, though it is not critical.	6

[gstraccini]

This pull request is ready ✅ for merge/squash.

[gstraccini]

This pull request is ready ✅ for merge/squash.

[github-actions]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

9:46PM INF scanning for exposed secrets...
9:46PM INF 54 commits scanned.
9:46PM INF scan completed in 72ms
9:46PM INF no leaks found