Skip to content

Commit 4998f6e

Browse files
DCodeProgDCodeProg
authored
ci: add github templates (#3)
* feat: add task issue template * feat: add feature request issue template * feat: add bug report issue template * feat: add pull request template
1 parent 3c127fb commit 4998f6e

File tree

4 files changed

+185
-0
lines changed

4 files changed

+185
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: 🐛 Bug Report
2+
description: Report a reproducible issue in the API
3+
labels: [bug]
4+
body:
5+
- type: input
6+
id: summary
7+
attributes:
8+
label: Summary
9+
description: Concisely describe the bug
10+
placeholder: "API returns 500 when posting to /users"
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: steps
16+
attributes:
17+
label: Steps to Reproduce
18+
description: Provide detailed steps, including endpoint, payload, headers, and auth context
19+
placeholder: |
20+
1. Endpoint: POST /api/v1/users
21+
2. Payload: { "name": "..." }
22+
3. Headers: Authorization: Bearer <token>
23+
4. Steps...
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: expected
29+
attributes:
30+
label: Expected Behavior
31+
description: What should have happened
32+
placeholder: "User is created and 201 is returned"
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: actual
38+
attributes:
39+
label: Actual Behavior
40+
description: What actually happened
41+
placeholder: "500 Internal Server Error"
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: logs
47+
attributes:
48+
label: Logs / Stack Trace
49+
description: Paste relevant logs or stack trace
50+
render: shell
51+
52+
- type: input
53+
id: environment
54+
attributes:
55+
label: Environment
56+
description: Java version, Spring Boot version, build tool, deployment context
57+
placeholder: "Java 25, Spring Boot 3.5.7, Maven 3.9.5, Docker"
58+
59+
- type: checkboxes
60+
attributes:
61+
label: Pre-checks
62+
options:
63+
- label: I have searched existing issues to avoid duplicates
64+
required: true
65+
- label: I have tested with the latest version
66+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or improvement
3+
labels: [enhancement]
4+
body:
5+
- type: input
6+
id: summary
7+
attributes:
8+
label: Summary
9+
description: Concisely describe the feature
10+
placeholder: "Add pagination to /users endpoint"
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: problem
16+
attributes:
17+
label: Problem Statement
18+
description: What problem does this feature solve?
19+
placeholder: "Currently, fetching all users at once is inefficient..."
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: solution
25+
attributes:
26+
label: Proposed Solution
27+
description: Describe your proposed solution
28+
placeholder: "Implement pageable queries with limit/offset parameters"
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: alternatives
34+
attributes:
35+
label: Alternatives Considered
36+
description: Have you considered other approaches?
37+
placeholder: "Client-side filtering, caching, etc."
38+
39+
- type: textarea
40+
id: context
41+
attributes:
42+
label: Additional Context
43+
description: Add any other context, screenshots, or references
44+
45+
- type: checkboxes
46+
id: confirmations
47+
attributes:
48+
label: Pre-Work Checklist
49+
description: Confirm these before starting
50+
options:
51+
- label: No existing issue covers this work.
52+
required: true

‎.github/ISSUE_TEMPLATE/task.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: 📋 Task
2+
description: Development or maintenance task
3+
labels: [task]
4+
5+
body:
6+
- type: input
7+
id: summary
8+
attributes:
9+
label: Summary
10+
description: Concisely describe the task
11+
placeholder: "Refactor UserService to improve readability"
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: details
17+
attributes:
18+
label: Details
19+
description: Provide more context or technical details
20+
placeholder: "Move validation logic into a separate component..."
21+
22+
- type: textarea
23+
id: subtasks
24+
attributes:
25+
label: Subtasks
26+
description: Break down the work into smaller actionable items
27+
placeholder: |
28+
- [ ] Implement new validation class
29+
- [ ] Update service layer
30+
- [ ] Add unit tests
31+
32+
- type: textarea
33+
id: notes
34+
attributes:
35+
label: Additional Notes / References
36+
description: Add any relevant links, documentation, or references
37+
placeholder: "See doc: https://..."
38+
39+
- type: checkboxes
40+
id: confirmations
41+
attributes:
42+
label: Pre-Work Checklist
43+
description: Confirm these before starting
44+
options:
45+
- label: No existing issue covers this work.
46+
required: true

‎.github/pull_request_template.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Description
2+
<!-- Describe your changes in detail -->
3+
4+
## Related Issue
5+
Closes #<issue-number>
6+
7+
## Type of Change
8+
- [ ] feat
9+
- [ ] fix
10+
- [ ] docs
11+
- [ ] refactor
12+
- [ ] chore
13+
- [ ] test
14+
- [ ] ci
15+
16+
## How Has This Been Tested?
17+
<!-- Describe test process and results -->
18+
19+
## Checklist
20+
- [ ] I have followed the Conventional Commits naming rules
21+
- [ ] I have added tests where applicable

0 commit comments

Comments
 (0)