feat: Create advanced issue template for contributors #1152
Conversation
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughAdds a new GitHub issue form template for "Advanced" issues at Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
🔇 Additional comments (6)
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 |
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #1152 +/- ##
=======================================
Coverage 91.19% 91.19%
=======================================
Files 139 139
Lines 8446 8446
=======================================
Hits 7702 7702
Misses 744 744 🚀 New features to boost your workflow:
|
MonaaEid
force-pushed
the
feat/1139-advanced_issue-template
branch
2 times, most recently
from
b527734 to
8316e3e
Compare
Signed-off-by: MonaaEid <[email protected]>
MonaaEid
force-pushed
the
feat/1139-advanced_issue-template
branch
from
8316e3e to
70d467f
Compare
There was a problem hiding this comment.
Pull request overview
This PR introduces a new advanced issue template to guide experienced contributors in creating high-impact issues for the Hiero Python SDK. The template complements the existing Good First Issue and Intermediate Issue templates by targeting contributors with deep familiarity with the SDK internals.
Key changes:
- Added
.github/ISSUE_TEMPLATE/06_advanced_issue.ymlwith structured prompts for problem description, proposed solution, implementation notes, and acceptance criteria - Updated CHANGELOG.md to document the new template addition
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
.github/ISSUE_TEMPLATE/06_advanced_issue.yml |
New advanced issue template providing structured guidance for experienced contributors reporting high-impact issues requiring deep SDK knowledge |
CHANGELOG.md |
Added changelog entry documenting the new advanced issue template |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/ISSUE_TEMPLATE/06_advanced_issue.yml(1 hunks)CHANGELOG.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md
[uncategorized] ~54-~54: The official name of this software platform is spelled with a capital “H”.
Context: ...advanced issue template for contributors .github/ISSUE_TEMPLATE/06_advanced_issue.yml. ...
(GITHUB)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: Agent
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: build-and-test (3.11)
- GitHub Check: build-and-test (3.12)
- GitHub Check: build-and-test (3.13)
- GitHub Check: build-and-test (3.10)
- GitHub Check: run-examples
- GitHub Check: StepSecurity Harden-Runner
🔇 Additional comments (9)
CHANGELOG.md (1)
54-54: LGTM!The changelog entry accurately documents the addition of the advanced issue template and follows the established formatting conventions.
.github/ISSUE_TEMPLATE/06_advanced_issue.yml (8)
1-6: LGTM! Template metadata is properly configured.The template metadata correctly implements all requirements:
- Descriptive name and description for advanced contributors
- Automatic "[Advanced]: " title prefix
- Applies "advanced" label automatically
- Empty assignees list as specified
25-44: Well-structured introductory section.This section effectively sets expectations for advanced contributors, clearly outlining required skills (SDK internals, multi-module navigation, API design decisions, working independently). Appropriately directs newer developers to starter issues.
71-115: LGTM! Problem section properly configured.The problem description section is well-designed with:
- Clear guidance on what to include
- Properly marked as required
- Helpful hidden example showing expected detail level
- Good emphasis on explaining current behavior, insufficiency, and affected components
116-154: LGTM! Solution section properly configured.The proposed solution section effectively guides contributors to think through:
- High-level approach and design
- New abstractions or changes to existing ones
- Constraints (backwards compatibility, performance, API stability)
- Alternatives considered
Properly marked as required with helpful hidden example.
155-193: LGTM! Implementation section provides thorough guidance.This optional section appropriately emphasizes its importance for advanced issues and provides comprehensive guidance on:
- Specific modules and classes
- Refactoring strategy
- Migration/deprecation concerns
- Testing strategy
- Performance and security considerations
The hidden example demonstrates the expected level of technical detail.
194-211: LGTM! Acceptance criteria fully aligned with requirements.The acceptance criteria section includes all required elements from issue #1139:
- Problem and design goals addressed
- Backwards compatibility maintained
- Architectural and coding conventions followed
- Comprehensive tests for new and existing behavior
- Examples and documentation updated
- CI checks passing
- Changelog entry included
- DCO and GPG-signed commits
Properly marked as required with clear checklist format.
213-226: LGTM! Additional context section appropriately configured.This optional section provides helpful guidance on useful references (design docs, prior discussions, related issues/PRs, external references) without requiring contribution. Appropriately placed as the final section.
32-32: The Hiero URL reference is correct. https://hiero.org is the official website of Hiero, which is the appropriate link for the Hiero project documentation and codebase.
Signed-off-by: MonaaEid <[email protected]>
|
Thank you @MonaaEid ! |
My pleasure! |
) Signed-off-by: MonaaEid <[email protected]> Signed-off-by: prajeeta pal <[email protected]>
2 participants
Description
This pull request introduces a new issue template designed specifically for advanced contributors to the Hiero Python SDK project. The template guides experienced developers in reporting high-impact issues that may affect core SDK behavior, ensuring submissions are detailed, actionable, and aligned with project standards.
Enhancements to contributor workflow:
.github/ISSUE_TEMPLATE/06_advanced_issue.yml) that provides structured prompts for problem description, proposed solution, implementation notes, and acceptance criteria, targeting contributors with deep familiarity with the SDK.Related issue(s):
Fixes #1139
Checklist
.github/ISSUE_TEMPLATE/06_advanced_issue.ymlSummary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.