Skip to content

Commit 2a89b19

Browse files
authored
Update pull request, feature request, and bug report templates (#2145)
Co-authored-by: acx10 <acx10@users.noreply.github.com>
1 parent 0fe883c commit 2a89b19

File tree

3 files changed

+64
-33
lines changed

3 files changed

+64
-33
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,6 @@ body:
88
value: |
99
Please fill out the details below so we can investigate and fix the issue.
1010
11-
- type: checkboxes
12-
id: prerequisites
13-
attributes:
14-
label: Quick Check
15-
options:
16-
- label: I've searched existing issues and this bug hasn't been reported yet
17-
required: true
18-
1911
- type: textarea
2012
id: description
2113
attributes:
@@ -77,3 +69,11 @@ body:
7769
validations:
7870
required: true
7971

72+
- type: checkboxes
73+
id: prerequisites
74+
attributes:
75+
label: Before Submitting
76+
description: Please confirm you've completed this step
77+
options:
78+
- label: I've searched existing issues and confirmed this bug hasn't been reported yet
79+
required: true

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,6 @@ body:
88
value: |
99
Please share as much detail as you can to help us understand your suggestion.
1010
11-
- type: checkboxes
12-
id: prerequisites
13-
attributes:
14-
label: Quick Check
15-
options:
16-
- label: I've searched existing issues and this feature hasn't been requested yet
17-
required: true
18-
1911
- type: textarea
2012
id: description
2113
attributes:
@@ -57,3 +49,18 @@ body:
5749
- "Just sharing the idea for now"
5850
validations:
5951
required: true
52+
53+
- type: textarea
54+
id: alternatives
55+
attributes:
56+
label: Have You Considered Any Alternatives? (Optional)
57+
description: Are there other ways to achieve what you want? Tell us about them
58+
59+
- type: checkboxes
60+
id: prerequisites
61+
attributes:
62+
label: Before Submitting
63+
description: Please confirm you've completed this step
64+
options:
65+
- label: I've searched existing issues and confirmed this feature hasn't been requested yet
66+
required: true

.github/pull_request_template.md

Lines changed: 41 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,59 @@
1-
# 🚀 Pull Request
1+
## 🚀 Pull Request
2+
3+
### 📝 Description
24

3-
## 📝 Description
45
<!-- Provide a clear and concise summary of the changes introduced in this pull request -->
56
<!-- Reference related issues using "Fixes #123", "Closes #456", or "Relates to #789" -->
67

8+
### 🛠️ Changes Implemented
79

8-
## 🛠️ Changes Implemented
910
<!-- Detail the specific modifications, additions, or removals made in this pull request -->
1011
-
1112

13+
### 🧪 Testing Strategy
1214

13-
## 🧪 Testing Strategy
1415
<!-- Describe the testing methodology used to verify the correctness of these changes -->
1516
<!-- Include testing approach, scenarios covered, and edge cases considered -->
1617

18+
### 📸 Visual Changes _(if applicable)_
1719

18-
## 📸 Visual Changes _(if applicable)_
1920
<!-- Attach screenshots or videos demonstrating UI/UX modifications -->
2021

2122

23+
---
24+
2225
## ⚠️ Required Pre-Submission Checklist
23-
<!-- ⛔ Pull requests will NOT be considered for review unless ALL required items are completed -->
24-
<!-- All items below are MANDATORY prerequisites for submission -->
25-
- [ ] Code adheres to project style guidelines and conventions
26-
- [ ] Branch synchronized with latest `develop` branch
27-
- [ ] Automated unit/integration tests added/updated to cover changes
28-
- [ ] All tests pass locally (`./gradlew test` for backend)
29-
- [ ] Manual testing completed in local development environment
30-
- [ ] Flyway migration versioning follows correct sequence _(if database schema modified)_
31-
- [ ] Documentation pull request submitted to [booklore-docs](https://github.com/booklore-app/booklore-docs) _(required for features or enhancements that introduce user-facing or visual changes)_
32-
33-
34-
## 💬 Additional Context _(optional)_
26+
27+
### **Please Read - This Checklist is Mandatory**
28+
29+
> **Important Notice:** We've experienced several production bugs recently due to incomplete pre-submission checks. To maintain code quality and prevent issues from reaching production, we're enforcing stricter adherence to this checklist.
30+
>
31+
> **All checkboxes below must be completed before requesting review.** PRs that haven't completed these requirements will be sent back for completion.
32+
33+
#### **Mandatory Requirements** _(please check ALL boxes)_:
34+
35+
- [ ] **Code adheres to project style guidelines and conventions**
36+
- [ ] **Branch synchronized with latest `develop` branch** _(please resolve any merge conflicts)_
37+
- [ ] **🚨 CRITICAL: Automated unit/integration tests added/updated to cover changes** _(MANDATORY for ALL backend changes - this is non-negotiable)_
38+
- [ ] **🚨 CRITICAL: All tests pass locally** _(run `./gradlew test` for backend - NO EXCEPTIONS)_
39+
- [ ] **🚨 CRITICAL: Manual testing completed in local development environment** _(verify your changes work AND no existing functionality is broken - test related features thoroughly)_
40+
- [ ] **Flyway migration versioning follows correct sequence** _(if database schema was modified)_
41+
- [ ] **Documentation PR submitted to [booklore-docs](https://github.com/booklore-app/booklore-docs)** _(required for features or enhancements that introduce user-facing or visual changes)_
42+
43+
#### **Why This Matters:**
44+
45+
Recent production incidents have been traced back to:
46+
47+
- **Incomplete testing coverage (especially backend)**
48+
- Merge conflicts not resolved before merge
49+
- Missing documentation for new features
50+
51+
**Backend changes without tests will not be accepted.** By completing this checklist thoroughly, you're helping maintain the quality and stability of Booklore for all users.
52+
53+
**Note to Reviewers:** Please verify the checklist is complete before beginning your review. If items are unchecked, kindly ask the contributor to complete them first.
54+
55+
---
56+
57+
### 💬 Additional Context _(optional)_
58+
3559
<!-- Provide any supplementary information, implementation considerations, or discussion points for reviewers -->

0 commit comments

Comments
 (0)