Create pull_request_template.md

[guibranco]

Description by Korbit AI

What change is being made?

Add a pull request template to the repository to standardize PR submissions.

Why are these changes being made?

This template will ensure that all necessary information is provided with each PR, improving the review process and maintaining consistency across contributions. It addresses the need for a structured format to capture essential details and checklist items for PRs.

[semanticdiff-com[bot]]

Review changes with SemanticDiff.

[korbit-ai[bot]]

My review is in progress :book: - I will have feedback for you in a few minutes!

[senior-dev-bot[bot]]

Hi there! :wave: Thanks for opening a PR. It looks like you've already reached the 5 review limit on our Basic Plan for the week. If you still want a review, feel free to upgrade your subscription in the Web App and then reopen the PR

[pr-code-reviewer[bot]]

:wave: Hi there!

Everything looks good!

_{^{Automatically generated with the help of gpt-3.5-turbo. Feedback? Please don't hesitate to drop me an email at webber@takken.io.}}

[codara-ai-code-review[bot]]

Potential issues, bugs, and flaws that can introduce unwanted behavior:

1. .github/pull_request_template.md:
   • Including a generic template without specific details could lead to incomplete or vague pull requests.
   • Hardcoding #ISSUE_NUMBER instead of dynamically referencing the related issue number could cause oversights.
   • Not specifying what constitutes a breaking change or providing examples might lead to confusion.

Code suggestions and improvements for better exception handling, logic, standardization, and consistency:

1. .github/pull_request_template.md:
   • Encourage contributors to provide detailed information about the current behavior being modified.
   • Encourage contributors to fill in details about the behavior changes made in the pull request.
   • Consider providing examples or guidelines on what constitutes a breaking change for clarity.
   • Instead of hardcoding #ISSUE_NUMBER, dynamically link to the related issue to maintain traceability.
   • Encourage contributors to add tests for changes and review/update documentation accordingly.

[instapr[bot]]

Feedback:

• Add some example descriptions for the "Before the change?" and "After the change?" sections.
• Provide a brief explanation for the "Pull request checklist" items.

[deepsource-io[bot]]

Here's the code health analysis summary for commits fbb29bf..ea65cb7. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Test coverage	✅ Success		View Check ↗
Secrets	✅ Success		View Check ↗
C#	✅ Success		View Check ↗

Code Coverage Report

Metric	Aggregate	C#
Branch Coverage	100%	100%
Composite Coverage	0%	0%
Line Coverage	0%	0%

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[gooroo-dev[bot]]

Please double check the following review of the pull request:

Issues counts

🐞Mistake	🤪Typo	🚨Security	🚀Performance	💪Best Practices	📖Readability	❓Others
0	0	0	0	1	0	0

Changes in the diff

• 🛠️ Created a new file pull_request_template.md with a template for pull requests.

Identified Issues

ID	Type	Details	Severity	Confidence
1	💪Best Practices	Placeholder for issue number should be more descriptive (#ISSUE_NUMBER)	🟠Medium	🟠Medium

Issue 1: Placeholder for issue number should be more descriptive

Details: The placeholder #ISSUE_NUMBER in the template is not very descriptive. It could be improved to guide contributors better.

File Path: .github/pull_request_template.md

Lines of Code:

Resolves #ISSUE_NUMBER

Suggested Code:

Resolves #[Insert issue number here]

Explanation: Changing the placeholder to #[Insert issue number here] makes it clearer for contributors to replace the placeholder with the actual issue number.

Missing Tests

Since this is a template file for pull requests, no code tests are necessary. However, it is important to ensure that the template is clear and easy to follow for contributors.

Summon me to re-review when updated! Yours, Gooroo.dev Please react or reply to this review!

[coderabbitai[bot]]

[!WARNING]

Rate limit exceeded

@guibranco has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 12 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](https://coderabbit.ai/docs/faq) for further information.

Commits

Files that changed from the base of the PR and between fbb29bf9775f833da2558af2faed2e23c8ea7d1c and ea65cb7080a2467651a6fb9c546099707f3e615d.

---

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[github-actions[bot]]

Infisical secrets check: :white_check_mark: No secrets leaked!

Scan results:

8:29PM INF scanning for exposed secrets...
8:29PM INF 17 commits scanned.
8:29PM INF scan completed in 65ms
8:29PM INF no leaks found

[sonarcloud[bot]]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[gstraccini[bot]]

I'm sorry @coderabbitai[bot], I can't do that. You aren't a collaborator in this repository. :pleading_face:

[coderabbitai[bot]]

Skipped: Cannot respond to another bot.

[gstraccini[bot]]

I'm sorry @coderabbitai[bot], I can't do that. You aren't a collaborator in this repository. :pleading_face:

[coderabbitai[bot]]

Skipped: Cannot respond to another bot.