neon-sprawl/docs/plans/README.md

20 lines
1.2 KiB
Markdown

# Implementation plans (`docs/plans/`)
Story-level implementation plans live here, keyed by **Linear issue id** (`NEO-*`) when the work is tracked in Linear (team **NEO**, Neon Sprawl).
## Legacy `NEON-*` filenames
A small number of files keep the historical **Jira / Atlassian `NEON-*`** key in the **filename** only. They are **not** the active issue tracker for new work.
- Each such file includes a short **Historical** banner at the top pointing at the matching **`NEO-*`** plan (same scope) where kickoff and commits should align.
- Prefer opening and linking **`NEO-*`** issues and plans for new contributors.
## GitHub links in Linear (and docs)
The canonical public repo path is **`ViPro-Technologies/neon-sprawl`** (see `git remote`). Use that org in **raw GitHub** markdown links (`https://github.com/ViPro-Technologies/neon-sprawl/blob/main/...`). The path **`neon-sprawl/neon-sprawl`** is not the live repo and will **404**.
## Conventions
- New or moved plans: `docs/plans/{LINEAR_KEY}-implementation-plan.md` (see [story kickoff](../../.cursor/rules/story-kickoff.md)).
- Cross-links from decomposition and game-design docs should use **`NEO-*`** URLs (Linear) for current engineering work.