|
1 | | -# 🚀 Pull Request |
| 1 | +## 🚀 Pull Request |
| 2 | + |
| 3 | +### 📝 Description |
2 | 4 |
|
3 | | -## 📝 Description |
4 | 5 | <!-- Provide a clear and concise summary of the changes introduced in this pull request --> |
5 | 6 | <!-- Reference related issues using "Fixes #123", "Closes #456", or "Relates to #789" --> |
6 | 7 |
|
| 8 | +### 🛠️ Changes Implemented |
7 | 9 |
|
8 | | -## 🛠️ Changes Implemented |
9 | 10 | <!-- Detail the specific modifications, additions, or removals made in this pull request --> |
10 | 11 | - |
11 | 12 |
|
| 13 | +### 🧪 Testing Strategy |
12 | 14 |
|
13 | | -## 🧪 Testing Strategy |
14 | 15 | <!-- Describe the testing methodology used to verify the correctness of these changes --> |
15 | 16 | <!-- Include testing approach, scenarios covered, and edge cases considered --> |
16 | 17 |
|
| 18 | +### 📸 Visual Changes _(if applicable)_ |
17 | 19 |
|
18 | | -## 📸 Visual Changes _(if applicable)_ |
19 | 20 | <!-- Attach screenshots or videos demonstrating UI/UX modifications --> |
20 | 21 |
|
21 | 22 |
|
| 23 | +--- |
| 24 | + |
22 | 25 | ## ⚠️ 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 | + |
35 | 59 | <!-- Provide any supplementary information, implementation considerations, or discussion points for reviewers --> |
0 commit comments