Skip to content

Commit 70bc669

Browse files
authored
Merge pull request #544 from nanotaboada/chore/update-github-templates
chore(github): update issue templates and add PR template
2 parents d8b6fd3 + 03c8d9f commit 70bc669

File tree

5 files changed

+49
-8
lines changed

5 files changed

+49
-8
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
name: Bug report
33
about: Report a bug or unexpected behavior
4-
title: "[BUG]"
5-
labels: bug
4+
title: ''
5+
labels: bug, python
66
assignees: ''
77

88
---

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Feature request
33
about: Propose a new feature or enhancement
4-
title: "[FEATURE]"
4+
title: ''
55
labels: enhancement, python
66
assignees: ''
77

@@ -15,17 +15,17 @@ What problem are you trying to solve? What's the pain point?
1515

1616
Describe the expected behavior and functionality this feature will provide.
1717

18-
## Suggested Approach
18+
## Suggested Approach _(optional)_
1919

20-
Describe the technical implementation plan. Include architecture, key files/modules to modify, APIs, and any code patterns to follow.
20+
If known, describe the technical implementation plan. Include architecture, key files/modules to modify, APIs, and any code patterns to follow.
2121

2222
## Acceptance Criteria
2323

2424
How will we know this feature is complete and working correctly?
2525

26-
- [ ] Criterion 1
27-
- [ ] Criterion 2
28-
- [ ] Criterion 3
26+
- [ ] Feature behaves as described in the proposed solution
27+
- [ ] Tests are added or updated to cover the new functionality
28+
- [ ] No regressions in existing tests
2929

3030
## References
3131

.github/copilot-instructions.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,25 @@ Never suggest a release tag with a coach name not on this list.
168168
`schemas/player_schema.py` and `tools/` seed scripts
169169
- Production configurations
170170

171+
### Creating Issues
172+
173+
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.
174+
175+
**Feature request** (`enhancement` label):
176+
- **Problem**: the pain point being solved
177+
- **Proposed Solution**: expected behavior and functionality
178+
- **Suggested Approach** *(optional)*: implementation plan if known
179+
- **Acceptance Criteria**: at minimum — behaves as proposed, tests added/updated, no regressions
180+
- **References**: related issues, docs, or examples
181+
182+
**Bug report** (`bug` label):
183+
- **Description**: clear summary of the bug
184+
- **Steps to Reproduce**: numbered, minimal steps
185+
- **Expected / Actual Behavior**: one section each
186+
- **Environment**: runtime versions + OS
187+
- **Additional Context**: logs, screenshots, stack traces
188+
- **Possible Solution** *(optional)*: suggested fix or workaround
189+
171190
### Key workflows
172191

173192
**Add an endpoint**: Add Pydantic model in `models/` if the request/response

.github/pull_request_template.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Summary
2+
3+
Brief description of the changes and why they were made.
4+
5+
## Type of Change
6+
7+
- [ ] `feat` — new feature
8+
- [ ] `fix` — bug fix
9+
- [ ] `chore` — maintenance, tooling, or dependency update
10+
- [ ] `docs` — documentation only
11+
- [ ] `test` — adding or updating tests
12+
- [ ] `refactor` — code change that neither fixes a bug nor adds a feature
13+
- [ ] `ci` — CI/CD changes
14+
- [ ] `perf` — performance improvement
15+
16+
## Checklist
17+
18+
- [ ] `CHANGELOG.md` updated
19+
- [ ] All tests pass
20+
- [ ] No regressions introduced
21+
- [ ] Follows project coding guidelines

0 commit comments

Comments
 (0)