Skip to content

Commit 6c2ae1e

Browse files
authored
Merge pull request #1399 from max-svistunov/lcore-1576-feature-design-process
LCORE-1576: Document feature design process: howtos, templates, skills & CLI tool
2 parents d206a03 + 66d3557 commit 6c2ae1e

12 files changed

Lines changed: 1118 additions & 0 deletions

.claude/commands/file-jiras.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Parse proposed JIRAs from a spike doc and file them via the Jira API
2+
3+
You are filing JIRA sub-tickets for a Lightspeed Core feature.
4+
5+
The user will provide either a spike doc path or tell you which feature's
6+
JIRAs to file. They will also provide the parent JIRA ticket number.
7+
8+
## Credentials
9+
10+
Jira credentials must be in `~/.config/jira/credentials.json`. If this file
11+
doesn't exist, tell the user to create it (see `dev-tools/file-jiras.sh` for
12+
the format and instructions).
13+
14+
## Process
15+
16+
1. Run `dev-tools/file-jiras.sh <spike-doc.md> <parent-ticket>` with
17+
`echo "quit"` piped in, so it parses and exits without filing.
18+
19+
2. Read every file in `/tmp/jiras/`. For each, verify:
20+
- Content matches the corresponding section in the spike doc (no truncation,
21+
no extra content swallowed from subsequent sections).
22+
23+
3. Report any issues to the user. If all files look correct, tell the user
24+
to run the script interactively — provide the full command including `cd`
25+
to the repository root:
26+
`cd <repo-path> && sh dev-tools/file-jiras.sh <spike-doc.md> <parent-ticket>`

.claude/commands/spec-doc.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Create a feature spec doc with requirements, architecture, and implementation guide
2+
3+
You are creating a feature spec doc for the Lightspeed Core project.
4+
5+
Follow the guidance in `docs/contributing/howto-write-a-spec-doc.md`. Use
6+
`docs/contributing/templates/spec-doc-template.md` as the starting point.
7+
8+
The user will provide context about the feature — a spike doc, a description,
9+
or a conversation. Read what is provided and ask for anything missing.
10+
11+
Place the spec doc at `docs/design/<feature>/<feature>.md`. Confirm the
12+
feature name and path with the user.

.claude/commands/spike.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Run a design spike: research, PoC, decisions, and proposed JIRAs
2+
3+
You are starting a spike for a feature in the Lightspeed Core project.
4+
5+
Follow the process in `docs/contributing/howto-run-a-spike.md`. Use the
6+
templates it references.
7+
8+
The user will provide context about the feature — a JIRA ticket, a description,
9+
or a conversation. Read what is provided and ask for anything missing.
10+
11+
At decision points, present what you've found and ask the user before proceeding.
12+
The user makes the decisions — you assist with the research and documenting.

0 commit comments

Comments
 (0)