Skip to content

Commit 7775e3e

Browse files
stefaniukstefaniuk
committed
feat(prompts): enhance workflow context and requirements in implementation and planning prompts
1 parent a8da1e1 commit 7775e3e

File tree

7 files changed

+193
-71
lines changed

7 files changed

+193
-71
lines changed

‎.github/copilot-instructions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
- [ ] Read and adhere to the [constitution](../.specify/memory/constitution.md) at all times
1111

12-
## Documentation (Mandatory)
12+
## Documentation ADRs (Mandatory)
1313

1414
When making architectural or significant technical decisions, document them as Architecture Decision Records (ADRs):
1515

‎.github/prompts/speckit.implement.prompt.md‎

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,34 @@
22
agent: speckit.implement
33
---
44

5-
You must adhere to the following mandatory implementation requirements when writing code for features.
5+
You **MUST** adhere to the following mandatory requirements when implementing features.
66

7-
## Repository Tooling (Mandatory)
7+
**Workflow context:**
88

9-
- [ ] When you identify missing development capabilities (linting, CI/CD, Docker support, pre-commit hooks, etc.), consult the repository-template skill at [.github/skills/repository-template/SKILL.md](/.github/skills/repository-template/SKILL.md) for standardised implementations.
9+
- **Input:** `tasks.md` (actionable task list)
10+
- **Output:** Working code with passing tests
11+
- **Verification:** Execute Show & Tell steps after each phase
1012

11-
## Quality Gates (Mandatory)
13+
**Base requirements:** Follow all rules in [copilot-instructions.md](/.github/copilot-instructions.md), particularly:
1214

13-
After any source code change:
15+
- Repository Tooling
16+
- Test-Driven Development
17+
- Quality Gates
1418

15-
1. [ ] Run `make lint` and `make test`
16-
2. [ ] Fix all errors and warnings — including those in files you not modified
17-
3. [ ] Repeat until both commands complete with zero errors and zero warnings
18-
4. [ ] Do this automatically without prompting
19+
## Implementation Process (Mandatory)
20+
21+
1. Work through tasks in `tasks.md` sequentially
22+
2. Follow TDD: write failing test first, then implement, then refactor
23+
3. After completing each phase or user story, execute its `### Show & Tell` steps to verify correctness
24+
4. Run `make lint` and `make test` after every source code change
25+
26+
## Implementation Completion Checklist (Mandatory)
27+
28+
Before marking implementation as complete, verify:
29+
30+
- [ ] All tasks in `tasks.md` are completed
31+
- [ ] Each repository-template capability that was planned to be implemented using the skill at [.github/skills/repository-template/SKILL.md](/.github/skills/repository-template/SKILL.md) is completed
32+
- [ ] TDD was followed: tests written before implementation
33+
- [ ] All `### Show & Tell` steps executed successfully for each phase
34+
- [ ] Repository-template capabilities are present and up to date (see [.github/skills/repository-template/SKILL.md](/.github/skills/repository-template/SKILL.md))
35+
- [ ] `make lint` and `make test` complete with zero errors and zero warnings

‎.github/prompts/speckit.plan.prompt.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,41 @@
22
agent: speckit.plan
33
---
44

5-
You must adhere to the following mandatory planning requirements when creating a development plan.
5+
You **MUST** adhere to the following mandatory requirements when creating a development plan.
66

7-
## Documentation (Mandatory)
7+
**Workflow context:**
88

9-
When making architectural or significant technical decisions, document them as Architecture Decision Records (ADRs):
9+
- **Input:** `spec.md` (feature specification)
10+
- **Output:** `plan.md` (implementation plan)
11+
- **Next phase:** Tasks generation (`/speckit.tasks`)
1012

11-
**What requires an ADR:**
13+
**Base requirements:** Follow all rules in [copilot-instructions.md](/.github/copilot-instructions.md), particularly:
1214

13-
- [ ] Architectural style choices (e.g. event-driven vs layered, monolith vs microservices)
14-
- [ ] Architectural pattern choices (e.g. composition over inheritance, repository pattern, event sourcing)
15-
- [ ] Language and framework selections
16-
- [ ] Any other significant technical decision that shapes the system
15+
- Documentation ADRs
16+
- Toolchain Version
17+
- Repository Tooling
1718

18-
**ADR requirements:**
19+
## Show & Tell Sections (Mandatory)
1920

20-
- [ ] Use the template at [docs/adr/adr-template.md](/docs/adr/adr-template.md)
21-
- [ ] Follow the existing ADR format for consistency
22-
- [ ] Always present 3 or more options with trade-offs
23-
- [ ] Include the conversational context that led to the decision
24-
- [ ] Document decisions regardless of whether you made them independently or were guided by the user
21+
Each phase and user story in `plan.md` must include a `### Show & Tell` subsection. This subsection defines the demonstration steps that will be:
2522

26-
This requirement is mandatory, especially during the spec-driven development cycle: `spec` → `plan` → `tasks` → `implement`.
23+
1. Expanded with specific commands in `tasks.md` (next phase)
24+
2. Executed by the user during implementation to verify completion
2725

28-
## Toolchain Version (Mandatory)
26+
## Plan Completion Checklist (Mandatory)
2927

30-
- [ ] Use the latest stable language, runtime, and framework versions at the time of change, search the internet for the latest versions
28+
Before marking `plan.md` as complete, verify:
3129

32-
## Plan (Mandatory)
33-
34-
- [ ] Plan each phase and user story to include a Show & Tell section with all instructions needed to demonstrate the completed work to stakeholders (e.g. terminal commands, browser navigation, API calls)
35-
- [ ] Plan to always bring the below capabilities as the minimum using the repository-template skill at [.github/skills/repository-template/SKILL.md](/.github/skills/repository-template/SKILL.md), and ensure they are up to date:
30+
- [ ] Plan addresses all requirements from `spec.md`
31+
- [ ] All architectural decisions have corresponding ADRs
32+
- [ ] Toolchain versions are specified
33+
- [ ] Repository-template capabilities are planned using the skill at [.github/skills/repository-template/SKILL.md](/.github/skills/repository-template/SKILL.md), including at minimum:
3634
- [ ] Core Make System
3735
- [ ] Pre-commit Hooks
3836
- [ ] Secret Scanning
3937
- [ ] File Format Checking
4038
- [ ] Markdown Linting
4139
- [ ] Docker Support
4240
- [ ] Tool Version Management
41+
- [ ] Each phase and user story includes a `### Show & Tell` subsection
42+
- [ ] Show & Tell subsections are placed at the end of each phase or user story

‎.github/prompts/speckit.tasks.prompt.md‎

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,54 @@
22
agent: speckit.tasks
33
---
44

5-
You must adhere to the following mandatory task creation requirements when generating development tasks.
5+
You **MUST** adhere to the following mandatory requirements when generating development tasks.
66

7-
## Test-Driven Development (Mandatory)
7+
**Workflow context:**
88

9-
- [ ] Define tasks using a strict TDD approach
10-
- [ ] For each specified functionality, sequence tasks as Red (write failing test first), Green (implement to pass), then Refactor (improve code without changing behaviour)
11-
- [ ] Ensure tests are always listed before implementation tasks
9+
- **Input:** `plan.md` (implementation plan)
10+
- **Output:** `tasks.md` (actionable task list)
11+
- **Next phase:** Implementation (`/speckit.implement`)
12+
13+
**Base requirements:** Follow all rules in [copilot-instructions.md](/.github/copilot-instructions.md), particularly:
14+
15+
- Repository Tooling
16+
- Test-Driven Development
17+
- Quality Gates
18+
19+
## Show & Tell Sections (Mandatory)
20+
21+
Each phase and user story in `tasks.md` must include a `### Show & Tell` subsection. Expand the outline from `plan.md` with specific executable steps:
22+
23+
- Terminal commands to run (with expected output)
24+
- Browser URLs to navigate (if applicable)
25+
- API calls to execute (if applicable)
26+
- Screenshots or expected visual state (described)
27+
28+
These steps will be executed during implementation to verify each phase is complete.
29+
30+
**Format example:**
31+
32+
````markdown
33+
### Show & Tell
34+
35+
```bash
36+
# Start the development server
37+
make run
38+
39+
# Expected: Server running at http://localhost:3000
40+
```
41+
42+
- Navigate to <http://localhost:3000/dashboard>
43+
- Verify the analytics widget displays sample data
44+
````
45+
46+
## Tasks Completion Checklist (Mandatory)
47+
48+
Before marking `tasks.md` as complete, verify:
49+
50+
- [ ] All phases and user stories from `plan.md` are covered
51+
- [ ] There is a task for each repository-template capability that was planned to be implemented using the skill at [.github/skills/repository-template/SKILL.md](/.github/skills/repository-template/SKILL.md)
52+
- [ ] TDD sequencing is applied: Red (write failing test), Green (implement to pass), Refactor
53+
- [ ] Test tasks are listed before their corresponding implementation tasks
54+
- [ ] Each phase and user story ends with a task that runs `make lint` and `make test`
55+
- [ ] Each phase and user story includes a `### Show & Tell` subsection with executable steps

‎.specify/extensions/prompts/speckit.implement.prompt.ext.md‎

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,31 @@
1-
You must adhere to the following mandatory implementation requirements when writing code for features.
1+
You **MUST** adhere to the following mandatory requirements when implementing features.
22

3-
## Repository Tooling (Mandatory)
3+
**Workflow context:**
44

5-
- [ ] When you identify missing development capabilities (linting, CI/CD, Docker support, pre-commit hooks, etc.), consult the repository-template skill at [.github/skills/repository-template/SKILL.md](/.github/skills/repository-template/SKILL.md) for standardised implementations.
5+
- **Input:** `tasks.md` (actionable task list)
6+
- **Output:** Working code with passing tests
7+
- **Verification:** Execute Show & Tell steps after each phase
68

7-
## Quality Gates (Mandatory)
9+
**Base requirements:** Follow all rules in [copilot-instructions.md](/.github/copilot-instructions.md), particularly:
810

9-
After any source code change:
11+
- Repository Tooling
12+
- Test-Driven Development
13+
- Quality Gates
1014

11-
1. [ ] Run `make lint` and `make test`
12-
2. [ ] Fix all errors and warnings — including those in files you not modified
13-
3. [ ] Repeat until both commands complete with zero errors and zero warnings
14-
4. [ ] Do this automatically without prompting
15+
## Implementation Process (Mandatory)
16+
17+
1. Work through tasks in `tasks.md` sequentially
18+
2. Follow TDD: write failing test first, then implement, then refactor
19+
3. After completing each phase or user story, execute its `### Show & Tell` steps to verify correctness
20+
4. Run `make lint` and `make test` after every source code change
21+
22+
## Implementation Completion Checklist (Mandatory)
23+
24+
Before marking implementation as complete, verify:
25+
26+
- [ ] All tasks in `tasks.md` are completed
27+
- [ ] Each repository-template capability that was planned to be implemented using the skill at [.github/skills/repository-template/SKILL.md](/.github/skills/repository-template/SKILL.md) is completed
28+
- [ ] TDD was followed: tests written before implementation
29+
- [ ] All `### Show & Tell` steps executed successfully for each phase
30+
- [ ] Repository-template capabilities are present and up to date (see [.github/skills/repository-template/SKILL.md](/.github/skills/repository-template/SKILL.md))
31+
- [ ] `make lint` and `make test` complete with zero errors and zero warnings

‎.specify/extensions/prompts/speckit.plan.prompt.ext.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
1-
You must adhere to the following mandatory planning requirements when creating a development plan.
1+
You **MUST** adhere to the following mandatory requirements when creating a development plan.
22

3-
## Documentation (Mandatory)
3+
**Workflow context:**
44

5-
When making architectural or significant technical decisions, document them as Architecture Decision Records (ADRs):
5+
- **Input:** `spec.md` (feature specification)
6+
- **Output:** `plan.md` (implementation plan)
7+
- **Next phase:** Tasks generation (`/speckit.tasks`)
68

7-
**What requires an ADR:**
9+
**Base requirements:** Follow all rules in [copilot-instructions.md](/.github/copilot-instructions.md), particularly:
810

9-
- [ ] Architectural style choices (e.g. event-driven vs layered, monolith vs microservices)
10-
- [ ] Architectural pattern choices (e.g. composition over inheritance, repository pattern, event sourcing)
11-
- [ ] Language and framework selections
12-
- [ ] Any other significant technical decision that shapes the system
11+
- Documentation ADRs
12+
- Toolchain Version
13+
- Repository Tooling
1314

14-
**ADR requirements:**
15+
## Show & Tell Sections (Mandatory)
1516

16-
- [ ] Use the template at [docs/adr/adr-template.md](/docs/adr/adr-template.md)
17-
- [ ] Follow the existing ADR format for consistency
18-
- [ ] Always present 3 or more options with trade-offs
19-
- [ ] Include the conversational context that led to the decision
20-
- [ ] Document decisions regardless of whether you made them independently or were guided by the user
17+
Each phase and user story in `plan.md` must include a `### Show & Tell` subsection. This subsection defines the demonstration steps that will be:
2118

22-
This requirement is mandatory, especially during the spec-driven development cycle: `spec` → `plan` → `tasks` → `implement`.
19+
1. Expanded with specific commands in `tasks.md` (next phase)
20+
2. Executed by the user during implementation to verify completion
2321

24-
## Toolchain Version (Mandatory)
22+
## Plan Completion Checklist (Mandatory)
2523

26-
- [ ] Use the latest stable language, runtime, and framework versions at the time of change, search the internet for the latest versions
24+
Before marking `plan.md` as complete, verify:
2725

28-
## Plan (Mandatory)
29-
30-
- [ ] Plan each phase and user story to include a Show & Tell section with all instructions needed to demonstrate the completed work to stakeholders (e.g. terminal commands, browser navigation, API calls)
31-
- [ ] Plan to always bring the below capabilities as the minimum using the repository-template skill at [.github/skills/repository-template/SKILL.md](/.github/skills/repository-template/SKILL.md), and ensure they are up to date:
26+
- [ ] Plan addresses all requirements from `spec.md`
27+
- [ ] All architectural decisions have corresponding ADRs
28+
- [ ] Toolchain versions are specified
29+
- [ ] Repository-template capabilities are planned using the skill at [.github/skills/repository-template/SKILL.md](/.github/skills/repository-template/SKILL.md), including at minimum:
3230
- [ ] Core Make System
3331
- [ ] Pre-commit Hooks
3432
- [ ] Secret Scanning
3533
- [ ] File Format Checking
3634
- [ ] Markdown Linting
3735
- [ ] Docker Support
3836
- [ ] Tool Version Management
37+
- [ ] Each phase and user story includes a `### Show & Tell` subsection
38+
- [ ] Show & Tell subsections are placed at the end of each phase or user story

‎.specify/extensions/prompts/speckit.tasks.prompt.ext.md‎

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,51 @@
1-
You must adhere to the following mandatory task creation requirements when generating development tasks.
1+
You **MUST** adhere to the following mandatory requirements when generating development tasks.
22

3-
## Test-Driven Development (Mandatory)
3+
**Workflow context:**
44

5-
- [ ] Define tasks using a strict TDD approach
6-
- [ ] For each specified functionality, sequence tasks as Red (write failing test first), Green (implement to pass), then Refactor (improve code without changing behaviour)
7-
- [ ] Ensure tests are always listed before implementation tasks
5+
- **Input:** `plan.md` (implementation plan)
6+
- **Output:** `tasks.md` (actionable task list)
7+
- **Next phase:** Implementation (`/speckit.implement`)
8+
9+
**Base requirements:** Follow all rules in [copilot-instructions.md](/.github/copilot-instructions.md), particularly:
10+
11+
- Repository Tooling
12+
- Test-Driven Development
13+
- Quality Gates
14+
15+
## Show & Tell Sections (Mandatory)
16+
17+
Each phase and user story in `tasks.md` must include a `### Show & Tell` subsection. Expand the outline from `plan.md` with specific executable steps:
18+
19+
- Terminal commands to run (with expected output)
20+
- Browser URLs to navigate (if applicable)
21+
- API calls to execute (if applicable)
22+
- Screenshots or expected visual state (described)
23+
24+
These steps will be executed during implementation to verify each phase is complete.
25+
26+
**Format example:**
27+
28+
````markdown
29+
### Show & Tell
30+
31+
```bash
32+
# Start the development server
33+
make run
34+
35+
# Expected: Server running at http://localhost:3000
36+
```
37+
38+
- Navigate to <http://localhost:3000/dashboard>
39+
- Verify the analytics widget displays sample data
40+
````
41+
42+
## Tasks Completion Checklist (Mandatory)
43+
44+
Before marking `tasks.md` as complete, verify:
45+
46+
- [ ] All phases and user stories from `plan.md` are covered
47+
- [ ] There is a task for each repository-template capability that was planned to be implemented using the skill at [.github/skills/repository-template/SKILL.md](/.github/skills/repository-template/SKILL.md)
48+
- [ ] TDD sequencing is applied: Red (write failing test), Green (implement to pass), Refactor
49+
- [ ] Test tasks are listed before their corresponding implementation tasks
50+
- [ ] Each phase and user story ends with a task that runs `make lint` and `make test`
51+
- [ ] Each phase and user story includes a `### Show & Tell` subsection with executable steps

0 commit comments

Comments
 (0)