|
| 1 | +--- |
| 2 | +name: issue-refinement-triage |
| 3 | +description: Refines GitHub issues into the ISSUE_REFINEMENTS format and keeps docs/ISSUE_REFINEMENTS.md in sync. Use when triaging issues, refining a new issue, updating the refinements doc, or when the user asks to refine an issue or add to refinements. |
| 4 | +--- |
| 5 | + |
| 6 | +# Issue Refinement and Triage |
| 7 | + |
| 8 | +## Canonical source |
| 9 | + |
| 10 | +Read [docs/ISSUE_REFINEMENTS.md](docs/ISSUE_REFINEMENTS.md) for the current open/closed list and label table before editing. |
| 11 | + |
| 12 | +## Issue block template |
| 13 | + |
| 14 | +Each refined issue uses this format. Separate blocks with `---`. |
| 15 | + |
| 16 | +```markdown |
| 17 | +### #N — Title |
| 18 | + |
| 19 | +**Labels:** `label1` `label2` |
| 20 | +**Context:** Raw description or user report. |
| 21 | +**Refined:** One-line actionable scope or decision. |
| 22 | +**My comments:** _(add notes here)_ |
| 23 | +``` |
| 24 | + |
| 25 | +## Labels (only these) |
| 26 | + |
| 27 | +| Label | Use for | |
| 28 | +| ------------------ | -------------------------------------- | |
| 29 | +| `bug` | Something broken or incorrect behavior | |
| 30 | +| `documentation` | Docs, README, FAQ, browser support | |
| 31 | +| `enhancement` | New feature or improvement | |
| 32 | +| `good first issue` | Clear, scoped tasks for contributors | |
| 33 | +| `question` | Open questions, naming, investigation | |
| 34 | +| `UI/UX` | User-facing behavior, flows, layout | |
| 35 | +| `Brainstorm` | Ideas, naming, long-running discussion | |
| 36 | +| `infrastructure` | CI/CD, release, monitoring, tooling | |
| 37 | + |
| 38 | +Suggest only these labels; use space-separated list in the block. |
| 39 | + |
| 40 | +## Workflow |
| 41 | + |
| 42 | +1. **New or raw issue:** Propose labels (from the table) and a one-line **Refined** that scopes or clarifies the issue. |
| 43 | +2. **Updating ISSUE_REFINEMENTS:** Add new refined issues under "Open issues (refined)". When an issue is closed, move its block to "Closed issues (reference)" and keep the same format. |
| 44 | +3. **My comments:** Reserved for maintainer notes (priority, blockers, batching). Leave as `*(add notes here)*` if no note. |
0 commit comments