Skip to content

Commit a9e5ab8

Browse files
nanotaboadaclaude
andcommitted
chore(github): document SDD workflow and issue templates in instructions
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 48c1032 commit a9e5ab8

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,25 @@ Example: `feat(api): add player search endpoint (#123)`
183183
- Database type (SQLite — demo/dev only)
184184
- CD pipeline tag format (`vX.Y.Z-stadium`) or the stadium name sequence — names are assigned sequentially A→Z from the list in `CHANGELOG.md`; the next name is always the next unused letter
185185

186+
### Creating Issues
187+
188+
This project uses Spec-Driven Development (SDD): discuss in Plan mode first, create a GitHub Issue as the spec artifact, then implement. Always offer to draft an issue before writing code.
189+
190+
**Feature request** (`enhancement` label):
191+
- **Problem**: the pain point being solved
192+
- **Proposed Solution**: expected behavior and functionality
193+
- **Suggested Approach** *(optional)*: implementation plan if known
194+
- **Acceptance Criteria**: at minimum — behaves as proposed, tests added/updated, no regressions
195+
- **References**: related issues, docs, or examples
196+
197+
**Bug report** (`bug` label):
198+
- **Description**: clear summary of the bug
199+
- **Steps to Reproduce**: numbered, minimal steps
200+
- **Expected / Actual Behavior**: one section each
201+
- **Environment**: runtime versions + OS
202+
- **Additional Context**: logs, screenshots, stack traces
203+
- **Possible Solution** *(optional)*: suggested fix or workaround
204+
186205
### Key workflows
187206

188207
**Add an endpoint**: Add DTO in `Models/` → update `PlayerMappingProfile` in `Mappings/` → add repository method(s) in `Repositories/` → add service method in `Services/` → add controller action in `Controllers/` → add/update validator rule set in `Validators/` → add tests in `test/.../Unit/` → run pre-commit checks.

0 commit comments

Comments
 (0)