chore: document Jira epic→story + labels (no Feature issues)
Module/slice grouping below epics is labels on stories only; Feature work items are not used. Cross-link from jira-git-naming, story kickoff, and documentation alignment table.pull/28/head
parent
fa19ab7337
commit
175c6e0500
|
|
@ -7,6 +7,10 @@ alwaysApply: true
|
||||||
|
|
||||||
Project key in Jira is **`NEON`** unless a different key is used for the issue (match the issue you are implementing).
|
Project key in Jira is **`NEON`** unless a different key is used for the issue (match the issue you are implementing).
|
||||||
|
|
||||||
|
## Issue hierarchy
|
||||||
|
|
||||||
|
Tracked work is **Epic → Story** (or Task/Bug). **Do not** create Jira **Feature** issues: module- or slice-level grouping below an epic is **labels on the story** only (prefer decomposition module ids such as **E1.M1** when they fit). Canonical wording: [decomposition README — Jira alignment](../../docs/decomposition/README.md#jira-alignment).
|
||||||
|
|
||||||
## Branch names
|
## Branch names
|
||||||
|
|
||||||
- Put the **Jira key first**, then a short **kebab-case** slug (and optional type). The key must be the **first path segment** of the branch name.
|
- Put the **Jira key first**, then a short **kebab-case** slug (and optional type). The key must be the **first path segment** of the branch name.
|
||||||
|
|
|
||||||
|
|
@ -11,6 +11,7 @@ When the user starts work on a **Jira story** (e.g. issue key `NEON-2`, phrases
|
||||||
|
|
||||||
- Fetch the issue when possible (e.g. Atlassian MCP `getJiraIssue`), or use a URL / pasted description the user provides.
|
- Fetch the issue when possible (e.g. Atlassian MCP `getJiraIssue`), or use a URL / pasted description the user provides.
|
||||||
- Capture summary, description, acceptance criteria, and anything explicitly **out of scope**.
|
- Capture summary, description, acceptance criteria, and anything explicitly **out of scope**.
|
||||||
|
- **Hierarchy:** Expect **Epic → Story** (or Task/Bug). **Do not** add or assume a Jira **Feature** layer—**module / slice** grouping is **labels on the story** (see [Jira alignment](../../docs/decomposition/README.md#jira-alignment) in the decomposition README).
|
||||||
|
|
||||||
## 1a. Board status (To Do → In Progress)
|
## 1a. Board status (To Do → In Progress)
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,6 +20,12 @@ This workspace contains detailed planning artifacts derived from the finalized m
|
||||||
3. Use stable IDs (`E1`, `E1.M1`, etc.) for core game epics; use **`CT.M1`**-style IDs for [content tooling](tooling/internal_authoring.md) so tooling stays out of the E1–E9 sequence.
|
3. Use stable IDs (`E1`, `E1.M1`, etc.) for core game epics; use **`CT.M1`**-style IDs for [content tooling](tooling/internal_authoring.md) so tooling stays out of the E1–E9 sequence.
|
||||||
4. Every new slice must reference telemetry and validation where applicable.
|
4. Every new slice must reference telemetry and validation where applicable.
|
||||||
|
|
||||||
|
## Jira alignment
|
||||||
|
|
||||||
|
Engineering work is tracked as **Stories** (or **Tasks** / **Bugs** when appropriate) **under Epics**. **Do not** create Jira **Feature** issues for module- or slice-level grouping—that middle tier is not used.
|
||||||
|
|
||||||
|
Express that grouping with **labels on the story** instead (for example the decomposition **module id** — `E1.M1`, `CT.M2`, etc. — or other labels the team maintains in Jira). The story still **belongs to the Epic** as today; labels carry what used to be “feature + labels on stories,” without a separate Feature work item.
|
||||||
|
|
||||||
## Epic files (E1–E9, master plan)
|
## Epic files (E1–E9, master plan)
|
||||||
|
|
||||||
| Epic | Document |
|
| Epic | Document |
|
||||||
|
|
@ -44,6 +50,6 @@ Template for new epics or major revisions: [epics/_epic_template.md](epics/_epic
|
||||||
|
|
||||||
## Next Actions
|
## Next Actions
|
||||||
|
|
||||||
1. Expand slices into engineering tickets; keep module IDs aligned with the master plan.
|
1. Expand slices into **stories** under epics; tag **module / slice** scope with **labels** (not Jira Features). Keep module IDs aligned with the master plan.
|
||||||
2. Populate `modules/module_dependency_register.md` as contracts stabilize.
|
2. Populate `modules/module_dependency_register.md` as contracts stabilize.
|
||||||
3. Refine `milestones/phase_execution_plan.md` with dates and owners when execution starts.
|
3. Refine `milestones/phase_execution_plan.md` with dates and owners when execution starts.
|
||||||
|
|
|
||||||
|
|
@ -11,6 +11,7 @@ The [module dependency register](module_dependency_register.md) **Status** colum
|
||||||
| **Register + module markdown** | Intent, dependencies, contracts, policies (authority, PvP, quests, ops). |
|
| **Register + module markdown** | Intent, dependencies, contracts, policies (authority, PvP, quests, ops). |
|
||||||
| **Code + tests** | What actually runs; paths under `server/`, `client/`, etc. |
|
| **Code + tests** | What actually runs; paths under `server/`, `client/`, etc. |
|
||||||
| **Plans** | `docs/plans/` (e.g. NEON-* implementation plans) tie stories to acceptance criteria. |
|
| **Plans** | `docs/plans/` (e.g. NEON-* implementation plans) tie stories to acceptance criteria. |
|
||||||
|
| **Jira** | Stories under epics; **module grouping = labels** on the story (no Jira **Feature** issues). [Decomposition README — Jira alignment](../README.md#jira-alignment). |
|
||||||
| **This doc’s tracking table** | Quick **inventory** of modules that have started implementation; expand as work lands. |
|
| **This doc’s tracking table** | Quick **inventory** of modules that have started implementation; expand as work lands. |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue