Open
Conversation
Reviewer's GuideAdds standardized GitHub issue templates for bug reports, feature requests, and a generic custom issue, to structure incoming issues and capture key diagnostic/contextual information from reporters. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 3 issues, and left some high level feedback:
- Consider setting default labels and/or assignees in the issue template front matter so new issues are automatically triaged into the right queues.
- The
custom.mdtemplate currently has only generic placeholder text; either remove it for now or replace the placeholders with a concrete use case to avoid confusion for reporters.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider setting default labels and/or assignees in the issue template front matter so new issues are automatically triaged into the right queues.
- The `custom.md` template currently has only generic placeholder text; either remove it for now or replace the placeholders with a concrete use case to avoid confusion for reporters.
## Individual Comments
### Comment 1
<location> `.github/ISSUE_TEMPLATE/bug_report.md:28` </location>
<code_context>
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
</code_context>
<issue_to_address>
**nitpick (typo):** Capitalize browser names in the example list.
For example, update to `- Browser [e.g. Chrome, Safari]` for consistency with product naming.
```suggestion
- Browser [e.g. Chrome, Safari]
```
</issue_to_address>
### Comment 2
<location> `.github/ISSUE_TEMPLATE/bug_report.md:34` </location>
<code_context>
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
</code_context>
<issue_to_address>
**nitpick (typo):** Capitalize "Safari" in the smartphone browser example.
For the browser example, use the correctly capitalized product name.
Suggested implementation:
```
- Browser [e.g. Chrome, Safari]
```
```
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, Safari]
```
</issue_to_address>
### Comment 3
<location> `.github/ISSUE_TEMPLATE/feature_request.md:10-11` </location>
<code_context>
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
</code_context>
<issue_to_address>
**suggestion (typo):** Consider using a more standard abbreviation like "e.g." instead of "Ex.".
To match standard technical writing, replace `Ex.` with `e.g.` or spell it out as `For example, I'm always frustrated when [...]`.
```suggestion
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. For example, I'm always frustrated when [...]
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Add standardized GitHub issue templates for bug reports, feature requests, and custom issues.
Documentation: