Skip to content

Commit 0bf70e0

Browse files
authored
Merge pull request #289 from nanotaboada/chore/update-github-templates
chore(github): update issue templates and add PR template
2 parents 1a8fab2 + 09f9006 commit 0bf70e0

File tree

5 files changed

+87
-6
lines changed

5 files changed

+87
-6
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Bug report
3+
about: Report a bug or unexpected behavior
4+
title: ''
5+
labels: bug, java
6+
assignees: ''
7+
8+
---
9+
10+
## Description
11+
12+
A clear and concise description of what the bug is.
13+
14+
## Steps to Reproduce
15+
16+
1. Step 1
17+
2. Step 2
18+
3. Step 3
19+
20+
## Expected Behavior
21+
22+
What you expected to happen.
23+
24+
## Actual Behavior
25+
26+
What actually happened.
27+
28+
## Environment
29+
30+
- **Java version:** (output of `java --version`)
31+
- **Spring Boot version:** (from `pom.xml`)
32+
- **OS:** (e.g., macOS 15.0, Ubuntu 24.04, Windows 11)
33+
34+
## Additional Context
35+
36+
Add any other context about the problem here (logs, screenshots, etc.).
37+
38+
## Possible Solution
39+
40+
(Optional) Suggest a fix or workaround if you have one.

.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, java
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
@@ -109,6 +109,25 @@ Example: `feat(api): add player stats endpoint (#42)`
109109
- Test database configuration (in-memory SQLite)
110110
- Production configurations or deployment secrets
111111

112+
### Creating Issues
113+
114+
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.
115+
116+
**Feature request** (`enhancement` label):
117+
- **Problem**: the pain point being solved
118+
- **Proposed Solution**: expected behavior and functionality
119+
- **Suggested Approach** *(optional)*: implementation plan if known
120+
- **Acceptance Criteria**: at minimum — behaves as proposed, tests added/updated, no regressions
121+
- **References**: related issues, docs, or examples
122+
123+
**Bug report** (`bug` label):
124+
- **Description**: clear summary of the bug
125+
- **Steps to Reproduce**: numbered, minimal steps
126+
- **Expected / Actual Behavior**: one section each
127+
- **Environment**: runtime versions + OS
128+
- **Additional Context**: logs, screenshots, stack traces
129+
- **Possible Solution** *(optional)*: suggested fix or workaround
130+
112131
### Key workflows
113132

114133
**Add an endpoint**: Define DTO in `models/` with Bean Validation → add service method in `services/` with `@Transactional` → create controller endpoint with `@Operation` annotation → add tests → run `./mvnw clean test jacoco:report`.

.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)