2026-04-01 13:20:43 +03:00
|
|
|
---
|
2026-04-01 13:21:20 +03:00
|
|
|
description: File a GitHub issue using the appropriate template
|
2026-04-01 13:20:43 +03:00
|
|
|
---
|
|
|
|
|
|
2026-05-04 12:10:46 +03:00
|
|
|
File a GitHub issue for the Kit repository. The user wants to create an issue about: $@
|
2026-04-01 13:21:20 +03:00
|
|
|
|
|
|
|
|
## Issue Templates Available
|
|
|
|
|
|
|
|
|
|
This repository has structured issue templates. You MUST use the appropriate template:
|
|
|
|
|
|
|
|
|
|
| Type | Template | Use For |
|
|
|
|
|
|------|----------|---------|
|
|
|
|
|
| `bug` | `bug_report` | Something is broken, not working as expected |
|
|
|
|
|
| `feat` | `feature_request` | New feature, enhancement, improvement |
|
|
|
|
|
| `docs` | `documentation` | Missing, incorrect, or unclear documentation |
|
2026-04-01 13:20:43 +03:00
|
|
|
|
|
|
|
|
## Steps
|
|
|
|
|
|
2026-05-04 12:10:46 +03:00
|
|
|
1. **Determine the issue type** from the user input: $@
|
2026-04-01 13:21:20 +03:00
|
|
|
- Bug → use `--template bug_report`
|
|
|
|
|
- Feature → use `--template feature_request`
|
|
|
|
|
- Documentation → use `--template documentation`
|
2026-04-01 13:20:43 +03:00
|
|
|
|
2026-04-01 13:21:20 +03:00
|
|
|
2. **Ask clarifying questions** if critical info is missing:
|
|
|
|
|
- For bugs: "What were you doing when this happened?" (reproduction steps)
|
|
|
|
|
- For features: "What problem does this solve?" (motivation)
|
|
|
|
|
- For docs: "Where did you look for this information?" (location)
|
2026-04-01 13:20:43 +03:00
|
|
|
|
|
|
|
|
3. **Craft the title** using conventional format:
|
|
|
|
|
- `<type>: <short description>`
|
|
|
|
|
- Lowercase, imperative mood, ≤72 chars
|
|
|
|
|
- Examples:
|
|
|
|
|
- `fix: ToolRenderConfig BorderColor ignored during rendering`
|
|
|
|
|
- `feat: add keyboard shortcut for clearing input`
|
|
|
|
|
- `docs: clarify extension widget lifecycle`
|
|
|
|
|
|
2026-04-01 13:21:20 +03:00
|
|
|
4. **File the issue** using the template:
|
2026-04-01 13:20:43 +03:00
|
|
|
```bash
|
2026-04-01 13:21:20 +03:00
|
|
|
# For bugs
|
|
|
|
|
gh issue create --template bug_report --title "fix: ..." --body "..."
|
|
|
|
|
|
|
|
|
|
# For features
|
|
|
|
|
gh issue create --template feature_request --title "feat: ..." --body "..."
|
|
|
|
|
|
|
|
|
|
# For documentation
|
|
|
|
|
gh issue create --template documentation --title "docs: ..." --body "..."
|
2026-04-01 13:20:43 +03:00
|
|
|
```
|
|
|
|
|
|
2026-04-01 13:21:20 +03:00
|
|
|
The template will guide the user through the required fields. You need to provide:
|
|
|
|
|
- **Bug reports**: Description, reproduction steps, expected vs actual behavior
|
|
|
|
|
- **Feature requests**: Description, motivation/use case, optional proposed implementation
|
|
|
|
|
- **Documentation**: Description, location of docs, suggested improvement
|
|
|
|
|
|
|
|
|
|
5. **Confirm success** by showing:
|
2026-04-01 13:20:43 +03:00
|
|
|
- The issue URL
|
|
|
|
|
- The issue number
|
2026-04-01 13:21:20 +03:00
|
|
|
- Which template was used
|
|
|
|
|
|
|
|
|
|
## Template Field Guide
|
|
|
|
|
|
|
|
|
|
### Bug Report (`bug_report`)
|
|
|
|
|
Required fields in the body:
|
|
|
|
|
- **Bug Description** - what happened vs expected
|
|
|
|
|
- **Steps to Reproduce** - numbered list to recreate the bug
|
|
|
|
|
- **Relevant Code** - code snippets, configuration, error messages
|
|
|
|
|
- **Component** - which part of Kit (ui, extensions, session, etc.)
|
|
|
|
|
- **Version** - Kit version or commit hash
|
|
|
|
|
|
|
|
|
|
### Feature Request (`feature_request`)
|
|
|
|
|
Required fields in the body:
|
|
|
|
|
- **Feature Description** - what to add/change
|
|
|
|
|
- **Motivation / Use Case** - why this is needed
|
|
|
|
|
- **Proposed Implementation** - how it could work (optional)
|
|
|
|
|
|
|
|
|
|
### Documentation (`documentation`)
|
|
|
|
|
Required fields in the body:
|
|
|
|
|
- **Documentation Issue** - what's wrong or missing
|
|
|
|
|
- **Documentation Location** - file or URL where docs exist
|
|
|
|
|
- **Suggested Improvement** - how to fix the docs
|
2026-04-01 13:20:43 +03:00
|
|
|
|
|
|
|
|
## Guidelines
|
|
|
|
|
|
2026-04-01 13:21:20 +03:00
|
|
|
- ALWAYS use `--template <name>` instead of bare `gh issue create`
|
2026-04-01 13:20:43 +03:00
|
|
|
- Include file paths and line numbers when you know them
|
2026-04-01 13:21:20 +03:00
|
|
|
- Use triple backticks for code blocks
|
2026-04-01 13:20:43 +03:00
|
|
|
- Keep the body factual - avoid speculation unless in "Proposed Fix" section
|
|
|
|
|
- If you're unsure about technical details, say so in the issue
|
|
|
|
|
- For UI bugs, describe what you see vs what you expect
|
|
|
|
|
- For API bugs, include the relevant struct/function names
|
|
|
|
|
|
|
|
|
|
## Example Usage
|
|
|
|
|
|
|
|
|
|
User: `/file-issue The ToolRenderConfig BorderColor field is documented but never used in rendering`
|
|
|
|
|
|
2026-04-01 13:21:20 +03:00
|
|
|
You:
|
|
|
|
|
1. Determine this is a **bug** (documented field doesn't work)
|
|
|
|
|
2. Use `--template bug_report`
|
|
|
|
|
3. Gather: reproduction steps (register renderer with BorderColor), expected (custom color), actual (default color)
|
|
|
|
|
4. Create issue with title `fix: ToolRenderConfig BorderColor and Background fields are ignored`
|
|
|
|
|
5. Confirm: Created issue #42 using bug_report template
|