mirror of
https://github.com/adityachandelgit/BookLore.git
synced 2026-01-17 01:21:28 +08:00
60 lines
2.9 KiB
Markdown
60 lines
2.9 KiB
Markdown
## 🚀 Pull Request
|
|
|
|
### 📝 Description
|
|
|
|
<!-- Provide a clear and concise summary of the changes introduced in this pull request -->
|
|
<!-- Reference related issues using "Fixes #123", "Closes #456", or "Relates to #789" -->
|
|
|
|
### 🛠️ Changes Implemented
|
|
|
|
<!-- Detail the specific modifications, additions, or removals made in this pull request -->
|
|
-
|
|
|
|
### 🧪 Testing Strategy
|
|
|
|
<!-- Describe the testing methodology used to verify the correctness of these changes -->
|
|
<!-- Include testing approach, scenarios covered, and edge cases considered -->
|
|
|
|
### 📸 Visual Changes _(if applicable)_
|
|
|
|
<!-- Attach screenshots or videos demonstrating UI/UX modifications -->
|
|
|
|
|
|
---
|
|
|
|
## ⚠️ Required Pre-Submission Checklist
|
|
|
|
### **Please Read - This Checklist is Mandatory**
|
|
|
|
> **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.
|
|
>
|
|
> **All checkboxes below must be completed before requesting review.** PRs that haven't completed these requirements will be sent back for completion.
|
|
|
|
#### **Mandatory Requirements** _(please check ALL boxes)_:
|
|
|
|
- [ ] **Code adheres to project style guidelines and conventions**
|
|
- [ ] **Branch synchronized with latest `develop` branch** _(please resolve any merge conflicts)_
|
|
- [ ] **🚨 CRITICAL: Automated unit tests added/updated to cover changes** _(MANDATORY for ALL Spring Boot backend and Angular frontend changes - this is non-negotiable)_
|
|
- [ ] **🚨 CRITICAL: All tests pass locally** _(run `./gradlew test` for Spring Boot backend, and `ng test` for Angular frontend - NO EXCEPTIONS)_
|
|
- [ ] **🚨 CRITICAL: Manual testing completed in local development environment** _(verify your changes work AND no existing functionality is broken - test related features thoroughly)_
|
|
- [ ] **Flyway migration versioning follows correct sequence** _(if database schema was modified)_
|
|
- [ ] **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)_
|
|
|
|
#### **Why This Matters:**
|
|
|
|
Recent production incidents have been traced back to:
|
|
|
|
- **Incomplete testing coverage (especially backend)**
|
|
- Merge conflicts not resolved before merge
|
|
- Missing documentation for new features
|
|
|
|
**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.
|
|
|
|
**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.
|
|
|
|
---
|
|
|
|
### 💬 Additional Context _(optional)_
|
|
|
|
<!-- Provide any supplementary information, implementation considerations, or discussion points for reviewers -->
|