Update issue templates #224
Conversation
|
Warning Rate limit exceeded@ParticularlyPythonicBS has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 43 seconds before requesting another review. ⌛ 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. 📒 Files selected for processing (3)
WalkthroughThree GitHub issue templates are introduced to standardize bug reports, feature requests, and user questions. Each template includes YAML front matter for metadata and structured Markdown sections with guidance and checklists to facilitate organized issue submission. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/ISSUE_TEMPLATE/bug_report.md (1)
14-21: Refine phrasing for formal tone.Line 16 uses "fix the issue" which could be more formal in a template context. Consider using "resolve" or "address" instead for consistency with professional issue-tracking conventions.
-Provide a clear, step-by-step procedure to reproduce the bug. This is crucial for us to understand and fix the issue. +Provide a clear, step-by-step procedure to reproduce the bug. This is crucial for us to understand and resolve the issue..github/ISSUE_TEMPLATE/question.md (1)
13-26: Refine phrasing for clarity and conciseness.The context and details sections use repetitive phrasing and redundant wording:
- Lines 16–17 repeat "trying to" three times in quick succession
- Line 22 uses "specific details" which is redundant (details are inherently specific)
These minor improvements would enhance readability without changing substance.
-* **What are you trying to do?** (e.g., "I'm trying to integrate X with Y," "I'm trying to achieve Z functionality.") -* **Why is this question important to you?** (e.g., "This is blocking my progress on feature A," "I'm trying to decide between two approaches.") +* **What are you trying to accomplish?** (e.g., "I'm integrating X with Y," "I'm implementing Z functionality.") +* **Why is this question important to you?** (e.g., "This is blocking my progress on feature A," "I'm evaluating two approaches.")-If applicable, provide specific details, code snippets, or examples that illustrate your question. This is especially helpful for questions related to: +If applicable, provide details, code snippets, or examples that illustrate your question. This is especially helpful for questions related to:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.github/ISSUE_TEMPLATE/bug_report.md(1 hunks).github/ISSUE_TEMPLATE/feature_request.md(1 hunks).github/ISSUE_TEMPLATE/question.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/ISSUE_TEMPLATE/question.md
[style] ~16-~16: You have already used ‘trying to’ in nearby sentences. Consider using one of the replacements to let your writing stand out.
Context: ...I'm trying to integrate X with Y," "I'm trying to achieve Z functionality.") * **Why is...
(REP_TRY)
[style] ~17-~17: You have already used ‘trying to’ in nearby sentences. Consider using one of the replacements to let your writing stand out.
Context: ...locking my progress on feature A," "I'm trying to decide between two approaches.") * **...
(REP_TRY)
[style] ~22-~22: This phrase is redundant. Consider writing “details”.
Context: ...ails & Examples If applicable, provide specific details, code snippets, or examples that illust...
(SPECIFIC_DETAILS)
.github/ISSUE_TEMPLATE/bug_report.md
[style] ~16-~16: Consider using a different verb for a more formal wording.
Context: ...his is crucial for us to understand and fix the issue. 1. Go to '...' 2. Click o...
(FIX_RESOLVE)
🔇 Additional comments (2)
.github/ISSUE_TEMPLATE/feature_request.md (1)
1-50: Well-structured feature request template.This template follows best practices for feature requests. It guides users through problem statement, proposed solution, benefits, and alternatives consideration. The checklist ensures key information is included.
.github/ISSUE_TEMPLATE/question.md (1)
37-41: Documentation URL verified as accessible.The external documentation link at line 39 (https://docs.temoaproject.org/en/latest/) returns HTTP 200, confirming it is valid and actively maintained. No issues found.
|
I reviewed these templates and they look good to me. |
ParticularlyPythonicBS
force-pushed
the
maintainance/issue_templates
branch
from
06832af to
44ba20a
Compare
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.