Skip to content

Commit 0efdefa

Browse files
committed
Add Claude Code skill references to howtos and contributing guide
1 parent 2019d07 commit 0efdefa

3 files changed

Lines changed: 10 additions & 0 deletions

File tree

docs/contributing/howto-run-a-spike.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ A spike is a time-boxed research task that produces a design recommendation and
44
proposed JIRAs. This document describes how to run one in the Lightspeed Core
55
project.
66

7+
**Claude Code shortcut**: `/spike` runs this process interactively.
8+
79
## Outputs
810

911
A spike produces:
@@ -149,6 +151,8 @@ Once all decisions are confirmed:
149151
1. Update the parent feature ticket description to point to the spec doc.
150152
2. File sub-JIRAs under the parent ticket using
151153
[jira-ticket-template.md](templates/jira-ticket-template.md).
154+
Use `dev-tools/file-jiras.sh` to parse and file them from the spike doc
155+
(Claude Code shortcut: `/file-jiras`).
152156
3. Each sub-JIRA's agentic tool instruction should point to the **spec doc**
153157
(not the spike doc), since the spec doc is the permanent reference.
154158

docs/contributing/howto-write-a-spec-doc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ A spec doc is the permanent in-repo feature specification. It is the single
44
source of truth for what the feature does and how it works. All implementation
55
JIRAs reference it. Agentic coding tools read it for guidance.
66

7+
**Claude Code shortcut**: `/spec-doc` creates one interactively.
8+
79
## When to write one
810

911
- As part of a spike (see [howto-run-a-spike.md](howto-run-a-spike.md), step 6).

docs/contributing_guide.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,10 @@ Templates for all of the above are in
149149
the spike, see
150150
[how to organize PoC output](contributing/howto-organize-poc-output.md).
151151

152+
**Claude Code shortcuts**: `/spike`, `/spec-doc`, and `/file-jiras` automate
153+
parts of this process. Use `dev-tools/file-jiras.sh` directly for JIRA filing
154+
without Claude Code.
155+
152156
## AI assistants
153157

154158
### “Mark” code with substantial AI-generated portions.

0 commit comments

Comments
 (0)