|
| 1 | +--- |
| 2 | +description: Add a new item to the product roadmap. Creates the feature markdown file, updates the overview table, searches for existing GitHub issues, and optionally creates a new issue. |
| 3 | +disable-model-invocation: true |
| 4 | +--- |
| 5 | + |
| 6 | +# Roadmap Item Management |
| 7 | + |
| 8 | +Add new items to the product roadmap at `docs/roadmap/`. Each roadmap item consists of a feature markdown file and a corresponding row in the overview table, optionally linked to a GitHub issue. |
| 9 | + |
| 10 | +## Workflow |
| 11 | + |
| 12 | +### Step 1: Gather Information |
| 13 | + |
| 14 | +Collect the following from the user before proceeding: |
| 15 | + |
| 16 | +| Field | Required | Notes | |
| 17 | +|-------|----------|-------| |
| 18 | +| Title | Yes | Human-readable feature name | |
| 19 | +| Status | Yes | One of: `Released`, `Planned`, `Approved` | |
| 20 | +| Summary | Yes | One-sentence description of the feature | |
| 21 | +| Problem | Yes | What limitation or gap this addresses | |
| 22 | +| Solution | Yes | How the feature solves the problem | |
| 23 | +| Impact | Yes | What users gain from this feature | |
| 24 | +| GitHub Issue | No | Whether to search for / create a GitHub issue | |
| 25 | + |
| 26 | +Use `AskUserQuestion` to collect any missing fields. All six content fields (Title, Summary, Problem, Solution, Impact, and Status) are required before creating the file. |
| 27 | + |
| 28 | +### Step 2: Search for Existing Issues |
| 29 | + |
| 30 | +Before creating a new issue, search for existing ones to avoid duplicates: |
| 31 | + |
| 32 | +```bash |
| 33 | +gh issue list --repo joggrdocs/code --search "<title or keywords>" --state all --limit 10 |
| 34 | +``` |
| 35 | + |
| 36 | +Present any matches to the user and ask whether to link an existing issue or create a new one. |
| 37 | + |
| 38 | +### Step 3: Create GitHub Issue (if requested) |
| 39 | + |
| 40 | +When the user wants a new issue, create it with the `enhancement` label: |
| 41 | + |
| 42 | +```bash |
| 43 | +gh issue create \ |
| 44 | + --repo joggrdocs/code \ |
| 45 | + --title "<Title>" \ |
| 46 | + --label "enhancement" \ |
| 47 | + --body "$(cat <<'EOF' |
| 48 | +## Summary |
| 49 | +
|
| 50 | +<Summary text> |
| 51 | +
|
| 52 | +## Problem |
| 53 | +
|
| 54 | +<Problem text> |
| 55 | +
|
| 56 | +## Solution |
| 57 | +
|
| 58 | +<Solution text> |
| 59 | +
|
| 60 | +## Impact |
| 61 | +
|
| 62 | +<Impact text> |
| 63 | +EOF |
| 64 | +)" |
| 65 | +``` |
| 66 | + |
| 67 | +Capture the issue number from the output for use in the overview table. |
| 68 | + |
| 69 | +### Step 4: Create Feature File |
| 70 | + |
| 71 | +Generate the filename by converting the title to kebab-case (lowercase, hyphens for spaces, strip special characters). Write the file to `docs/roadmap/features/<kebab-case-name>.md`. |
| 72 | + |
| 73 | +Use the format documented in `references/feature-template.md`. The status badge colors are: |
| 74 | + |
| 75 | +| Status | Badge | |
| 76 | +|--------|-------| |
| 77 | +| Released | `` | |
| 78 | +| Planned | `` | |
| 79 | +| Approved | `` | |
| 80 | + |
| 81 | +### Step 5: Update Overview Table |
| 82 | + |
| 83 | +Append a new row to the table in `docs/roadmap/overview.md`. The row format is: |
| 84 | + |
| 85 | +``` |
| 86 | +| [<Title>](./features/<kebab-case-name>.md) | <Summary> |  | <issue-link-or-dash> | |
| 87 | +``` |
| 88 | + |
| 89 | +Column order is: Feature, Description, Status, Issue. |
| 90 | + |
| 91 | +- For the issue column, use `[#N](https://github.com/joggrdocs/code/issues/N)` if an issue exists, otherwise use `-`. |
| 92 | +- Insert the new row in the correct status group: Released items first, then Planned, then Approved. |
| 93 | + |
| 94 | +### Step 6: Confirm |
| 95 | + |
| 96 | +After creating the files, display a summary: |
| 97 | + |
| 98 | +- Feature file path |
| 99 | +- Overview table updated |
| 100 | +- GitHub issue link (if created) |
| 101 | + |
| 102 | +## Reference Files |
| 103 | + |
| 104 | +- **`references/feature-template.md`** — Complete feature file template with correct badge format |
0 commit comments