create-github-issue

Create GitHub Issue

Create comprehensive GitHub issues using gh issue create by dynamically discovering and adhering to the repository's official issue templates.

Workflow

1. Discover and Select Template

CRITICAL: You must use the repository's official templates. Do not assume the structure.

1. List available templates:

   ls .github/ISSUE_TEMPLATE/
   

2. Select the most appropriate template based on the issue type (e.g., bug_report.yml, feature_request.yml).
3. Read the selected template to understand its required fields, structure, and any title prefixes or default labels.

   cat .github/ISSUE_TEMPLATE/<selected_template>.yml
   

2. Gather Context

Gather relevant information to fulfill the template requirements:

# Check current git status for context
git status

# View recent commits if related to codebase changes
git log --oneline -10

# Check if related issues exist
gh issue list --search "keyword" --limit 10

3. Generate Markdown Body

MANDATORY: Structure the issue body exactly as defined in the selected YAML template without exception.

1. Map YAML fields to Markdown: Convert each field in the template (typically found under body:) into a Markdown section.
2. Use Headers: Use the label or id from the YAML field as an H2 header (e.g., ## Bug Description).
3. Respect Validation: Ensure all fields marked as required: true in the YAML are populated with meaningful content.
4. Format Correctly: Use code blocks (e.g., ```shell, ```yaml) for logs and configurations as suggested by the template's render attribute.

4. Choose Labels

Select labels by inspecting .github/labels.json.

• Primary Label: Always include a type: label that matches the issue type.
• Additional Labels: Add relevant state:, work:, or priority: labels if they exist in the configuration.
• Constraint: Only use labels defined in .github/labels.json.

5. Create Title

Follow the template's title field if it provides a prefix (e.g., "[Bug]: ").

• Be concise: Keep under 70 characters.
• Use imperative mood: "Fix authentication timeout" instead of "Authentication is timing out".
• Start with action verb: Fix, Add, Improve, Update, Refactor.

6. Execute Issue Creation