📝 Walkthrough
## Walkthrough
The pull request modifies the pull request template found in `.github/pull_request_template.md`. Key changes include the removal of the "## " prefix from certain section headers, transforming them into single-level headers. The "Mandatory Tasks" section has been updated to incorporate checkboxes for GitHub and Linear issue numbers, with the original text removed. The checklist items have been reformatted and reworded to adopt a more casual tone. Additionally, a note has been added to the "Environment Setup" section, indicating its applicability as necessary.
## Changes
| File | Change Summary |
|-------------------------------------|---------------------------------------------------------------------------------------------------|
| .github/pull_request_template.md | - Changed section headers from `##` to `#` for "What does this PR do?", "Mandatory Tasks", "How should this be tested?", and "Checklist". - Updated "Mandatory Tasks" to include checkboxes for GitHub and Linear issue numbers. - Reformatted checklist items with periods and altered wording for a more casual tone. - Added a note to "Environment Setup" indicating its conditional applicability. |
## Possibly related PRs
- #476: The changes in this PR also involve modifications to the pull request template located in `.github/pull_request_template.md`, making it directly related to the main PR's updates to the same file.
## Suggested reviewers
- sajdakabir
> 🐰 In the land of code, where changes bloom,
> A template transformed, dispelling the gloom.
> With headers now simple, and tasks in a row,
> Casual and friendly, let the good vibes flow!
> A pinky swear promise, our code will be bright,
> Hop along, dear coder, let’s code through the night! 🌙✨
📜 Recent review details
**Configuration used: CodeRabbit UI**
**Review profile: CHILL**
📥 Commits
Reviewing files that changed from the base of the PR and between e2c42a815cfcacb572f7a809d6c4b12d9ceb2812 and 57e37877af7695034b0546b4e67813791b442817.
📒 Files selected for processing (1)
* `.github/pull_request_template.md` (1 hunks)
🧰 Additional context used🪛 LanguageTool.github/pull_request_template.md
[grammar] ~12-~12: Use an adverb or a verb between ‘I’ and ‘swear’.
Context: ...ut self-review might be rejected) - [ ] I pinky swear that my codes gonna work as I have test...
(PRP_NO_ADVERB_VERB)
---
[uncategorized] ~12-~12: Possible missing comma found.
Context: ...- [ ] I pinky swear that my codes gonna work as I have testing every possible scenar...
(AI_HYDRA_LEO_MISSING_COMMA)
---
[uncategorized] ~13-~13: You might be missing the article “the” here.
Context: ...ery possible scenario. - [ ] I ignored Coderabbit suggestion because it does not make any...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
---
[uncategorized] ~13-~13: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...gnored Coderabbit suggestion because it does not make any sense. - [ ] I took Codera...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
---
[uncategorized] ~33-~33: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...s. - [ ] I have checked if my branch is up to date with preview.
(UP_TO_DATE_HYPHEN)
🪛 Markdownlint.github/pull_request_template.md
10-10: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
---
27-27: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
---
22-22: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
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 , 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
📝 Walkthrough
## Walkthrough The pull request modifies the pull request template found in `.github/pull_request_template.md`. Key changes include the removal of the "## " prefix from certain section headers, transforming them into single-level headers. The "Mandatory Tasks" section has been updated to incorporate checkboxes for GitHub and Linear issue numbers, with the original text removed. The checklist items have been reformatted and reworded to adopt a more casual tone. Additionally, a note has been added to the "Environment Setup" section, indicating its applicability as necessary. ## Changes | File | Change Summary | |-------------------------------------|---------------------------------------------------------------------------------------------------| | .github/pull_request_template.md | - Changed section headers from `##` to `#` for "What does this PR do?", "Mandatory Tasks", "How should this be tested?", and "Checklist".- Updated "Mandatory Tasks" to include checkboxes for GitHub and Linear issue numbers.
- Reformatted checklist items with periods and altered wording for a more casual tone.
- Added a note to "Environment Setup" indicating its conditional applicability. | ## Possibly related PRs - #476: The changes in this PR also involve modifications to the pull request template located in `.github/pull_request_template.md`, making it directly related to the main PR's updates to the same file. ## Suggested reviewers - sajdakabir > 🐰 In the land of code, where changes bloom, > A template transformed, dispelling the gloom. > With headers now simple, and tasks in a row, > Casual and friendly, let the good vibes flow! > A pinky swear promise, our code will be bright, > Hop along, dear coder, let’s code through the night! 🌙✨
📜 Recent review details
**Configuration used: CodeRabbit UI** **Review profile: CHILL**📥 Commits
Reviewing files that changed from the base of the PR and between e2c42a815cfcacb572f7a809d6c4b12d9ceb2812 and 57e37877af7695034b0546b4e67813791b442817.📒 Files selected for processing (1)
* `.github/pull_request_template.md` (1 hunks)🧰 Additional context used
🪛 LanguageTool
.github/pull_request_template.md
[grammar] ~12-~12: Use an adverb or a verb between ‘I’ and ‘swear’. Context: ...ut self-review might be rejected) - [ ] I pinky swear that my codes gonna work as I have test... (PRP_NO_ADVERB_VERB) --- [uncategorized] ~12-~12: Possible missing comma found. Context: ...- [ ] I pinky swear that my codes gonna work as I have testing every possible scenar... (AI_HYDRA_LEO_MISSING_COMMA) --- [uncategorized] ~13-~13: You might be missing the article “the” here. Context: ...ery possible scenario. - [ ] I ignored Coderabbit suggestion because it does not make any... (AI_EN_LECTOR_MISSING_DETERMINER_THE) --- [uncategorized] ~13-~13: This verb may not be in the correct tense. Consider changing the tense to fit the context better. Context: ...gnored Coderabbit suggestion because it does not make any sense. - [ ] I took Codera... (AI_EN_LECTOR_REPLACEMENT_VERB_TENSE) --- [uncategorized] ~33-~33: It appears that hyphens are missing in the adjective “up-to-date”. Context: ...s. - [ ] I have checked if my branch is up to date with preview. (UP_TO_DATE_HYPHEN)🪛 Markdownlint
.github/pull_request_template.md
10-10: Punctuation: ':' Trailing punctuation in heading (MD026, no-trailing-punctuation) --- 27-27: Punctuation: ':' Trailing punctuation in heading (MD026, no-trailing-punctuation) --- 22-22: null Fenced code blocks should have a language specified (MD040, fenced-code-language)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