[Feature] Improve GitHub Issue Template Guidelines Placement #42
Conversation
WalkthroughThe pull request modifies the GitHub issue templates for bug reports, documentation, and feature requests by reinstating a checkboxes section. This section requires users to agree to the project's Contributing Guidelines and confirm they have searched for similar issues before submitting. The changes are consistent across all three issue template files, ensuring a uniform approach to issue submission guidelines. Changes
Assessment against linked issues
Possibly related PRs
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Relocated guidelines section in GitHub issue templates to improve user experience: - Moved guidelines checkbox section below the first content field - Maintained all existing guideline requirements - Reduced friction in issue creation workflow - Ensured clear visibility of contribution guidelines - Implemented in all issue templates (bug, feature, documentation) Rationale: - Current placement interrupts natural issue reporting flow - New placement allows more intuitive template progression - Keeps all compliance checks intact
Codecov ReportAll modified and coverable lines are covered by tests ✅ ✅ All tests successful. No failed tests found.
|
![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 (1)
.github/ISSUE_TEMPLATE/bug.yaml (1)
101-110: LGTM! Consistent implementation with contextual improvements.The guidelines section maintains consistency with other templates while appropriately adapting the verification checkbox text for bug reports ("similar issues" vs "hasn't been reported before").
Consider standardizing the checkbox text across all templates for better maintainability, though the current context-specific wording is also valid.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.github/ISSUE_TEMPLATE/bug.yaml(1 hunks).github/ISSUE_TEMPLATE/docs.yaml(1 hunks).github/ISSUE_TEMPLATE/feature.yaml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- .github/ISSUE_TEMPLATE/feature.yaml
🔇 Additional comments (1)
.github/ISSUE_TEMPLATE/docs.yaml (1)
63-72: LGTM! Guidelines section properly positioned.
The placement of the checkboxes section after the content fields aligns well with the PR objectives, creating a more natural flow for issue creation.
Let's verify the Contributing Guidelines link:
✅ Verification successful
Let me check the actual content of the CONTRIBUTING.md file to ensure it's properly linked and contains relevant guidelines.
Contributing Guidelines link is valid and points to a comprehensive document
The Contributing Guidelines link in the issue template points to a valid and well-structured document that exists at .github/CONTRIBUTING.md. The document is comprehensive, containing detailed sections about standards, issue reporting, pull requests, and other contribution aspects, making it a valuable reference for contributors.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify that the Contributing Guidelines file exists and is accessible
if [ -f ".github/CONTRIBUTING.md" ]; then
echo "Contributing Guidelines file exists"
# Check if it contains actual content
if [ -s ".github/CONTRIBUTING.md" ]; then
echo "Contributing Guidelines file is not empty"
else
echo "Warning: Contributing Guidelines file is empty"
fi
else
echo "Warning: Contributing Guidelines file not found"
fi
Length of output: 247
Script:
#!/bin/bash
# Display the content of CONTRIBUTING.md
cat .github/CONTRIBUTING.md
Length of output: 4881
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
CHANGELOG.md (1)
15-18: Remove the empty bullet point on line 18.There's an empty bullet point that should be removed to maintain changelog cleanliness.
Apply this diff:
### Fixed - Restructured issue template to reduce friction in reporting process - Maintained all existing guideline compliance checks --docs/changelog.rst (1)
12-17: Consider consolidating similar changelog entries.The current entries in the "Changed" section are somewhat redundant. Consider consolidating them into more specific, non-overlapping points.
-Changed -^^^^^^^ -- Improved GitHub issue template user experience -- Relocated guidelines checkbox section in issue templates -- Enhanced template layout for more intuitive issue creation workflow +Changed +^^^^^^^ +- Relocated guidelines checkbox section below first content field in GitHub issue templates +- Enhanced template layout for more intuitive issue creation workflow
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CHANGELOG.md(1 hunks)docs/changelog.rst(1 hunks)src/pkynetics/__about__.py(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- src/pkynetics/about.py
🔇 Additional comments (3)
CHANGELOG.md (2)
8-14: LGTM! Changes section accurately reflects the PR objectives.
The entries clearly document the improvements to the GitHub issue template user experience and the relocation of the guidelines section, aligning well with the PR objectives.
8-17: LGTM! Changelog format follows Keep a Changelog standards.
The entries are well-organized, properly categorized, and follow the recommended format with clear, action-oriented descriptions.
docs/changelog.rst (1)
9-11: LGTM! Version and date are appropriate.
The version increment to 0.3.2 is appropriate for these non-breaking changes to documentation and templates. The date is current.
| Fixed | ||
| ^^^^^ | ||
| - Restructured issue template to reduce friction in reporting process | ||
| - Maintained all existing guideline compliance checks | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Move template restructuring to "Changed" section.
The entries in the "Fixed" section don't describe actual fixes but rather improvements to the template structure. These should be moved to the "Changed" section since they're intentional improvements rather than bug fixes.
-Fixed
-^^^^^
-- Restructured issue template to reduce friction in reporting process
-- Maintained all existing guideline compliance checks
+Changed
+^^^^^^^
+- Relocated guidelines checkbox section below first content field in GitHub issue templates
+- Enhanced template layout for more intuitive issue creation workflow
+- Maintained all existing guideline compliance requirements📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Fixed | |
| ^^^^^ | |
| - Restructured issue template to reduce friction in reporting process | |
| - Maintained all existing guideline compliance checks | |
| Changed | |
| ^^^^^^^ | |
| - Relocated guidelines checkbox section below first content field in GitHub issue templates | |
| - Enhanced template layout for more intuitive issue creation workflow | |
| - Maintained all existing guideline compliance requirements | |
- Updated __about__.py with new version 0.3.2 - Added changelog entry for v0.3.2 in Markdown and RST formats
⚡ Have you read the Contributing Guidelines??
Fixes #41
Description
Relocated guidelines section in GitHub issue templates to improve user experience:
Rationale:
Type of Change
Checklist
black(line length 100)isortfor import sortingSummary by CodeRabbit
New Features
Bug Fixes
Chores