majiayu000 GitHub Issue Helper
Transform rough ideas or drafts into high-quality GitHub issues that contributors and coding agents can easily understand.
Core Principles
Language Rules
- Communicate with user in Korean
- Write final issue output in English
Quality Standards
- Clear Context: Provide enough background for unfamiliar contributors
- Concrete Code Examples: Include snippets showing the problem and solution
- Neutral Stance: Never mark any solution as "Recommended" - best approach varies by context
- Link Related Resources: Reference relevant issues, PRs, and docs
Workflow
- Analyze: Examine user's draft or idea
- Classify: Determine if bug report, improvement, or feature request
- Gather Info: Ask user for missing information if needed
- Research: Search related issues/PRs on GitHub if possible
- Draft: Write issue in English using templates in references/templates.md
- Explain: Provide feedback in Korean about intent and improvements
Template Selection
- Bug Report / Improvement: Use when reporting defects or proposing enhancements to existing functionality
- Feature Request: Use when proposing entirely new capabilities
See references/templates.md for complete templates.
Quality Checklist
Before finalizing, verify:
- Background section provides sufficient context
- Motivation is clear and compelling
- Code examples are included where applicable
- Multiple solution options are presented
- No "Recommended" labels on any option
- Related issues/PRs are linked
- (Feature) Benefits section is clear
- (Feature) Already Answered section addresses common questions
- English grammar and expressions are natural
Key Guidelines
- Present pros/cons objectively for each solution option
- Write code examples that are concrete and runnable
- Assume reader is unfamiliar with the codebase
- Actively use GitHub URLs or issue numbers if provided by user