| name | github-issue-creator |
| description | Structure bug reports, requirements, logs, or screenshots into actionable GitHub issues. Use it when you need acceptance criteria, scope definition, and a validation plan. |
GitHub Issue Creator
Purpose
Turn unstructured input into a GitHub issue that is ready for development.
Core Principles
- Put the acceptance criteria at the top using Given/When/Then.
- Separate In Scope from Out of Scope.
- An issue without a validation plan, automated or manual, is not complete.
- If information is missing, ask follow-up questions instead of guessing.
- Replace sensitive information with placeholders such as
[USER_ID] or [TOKEN].
- Include at least one recommended PR label for release categorization in the issue body.
Release Label Hints
Based on .github/release.yml, PR labels determine the release category.
New Features: feat, feature, enhancementBug Fixes: fix, bug, bugfixMaintenance (Chore): chore, dependencies, ci, build, refactor- Unmatched or missing labels:
Other Changes
Recommended:
- Include the
recommended PR label in the issue.
- Apply the same label on the implementation PR to avoid release-note classification gaps.
Output Format
Title
[type] one-line summary- type:
feat|fix|refactor|docs|chore|test
Acceptance Criteria
- Given ...
- When ...
- Then ...
Background or Problem
- Current state
- User or operational impact
Scope
Implementation Direction
- Target areas or modules
- Constraints and dependencies
- Risks
- Recommended PR label (
feat|feature|enhancement|fix|bug|bugfix|chore|dependencies|ci|build|refactor)
Validation Plan
- Automated validation: lint, build, test
- Manual validation: key scenarios
- For UI changes: screenshot checkpoints
Completion Criteria
- AC satisfied
- No regressions
- Release impact and cautions documented
Checklist
When Information Is Missing
- Draft the issue first.
- Limit follow-up questions to three.
