mirror of
https://github.com/booklore-app/booklore.git
synced 2026-02-18 00:17:53 +01:00
Update pull request, feature request, and bug report templates (#2145)
Co-authored-by: acx10 <acx10@users.noreply.github.com>
This commit is contained in:
16
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
16
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@@ -8,14 +8,6 @@ body:
|
||||
value: |
|
||||
Please fill out the details below so we can investigate and fix the issue.
|
||||
|
||||
- type: checkboxes
|
||||
id: prerequisites
|
||||
attributes:
|
||||
label: Quick Check
|
||||
options:
|
||||
- label: I've searched existing issues and this bug hasn't been reported yet
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
@@ -77,3 +69,11 @@ body:
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: prerequisites
|
||||
attributes:
|
||||
label: Before Submitting
|
||||
description: Please confirm you've completed this step
|
||||
options:
|
||||
- label: I've searched existing issues and confirmed this bug hasn't been reported yet
|
||||
required: true
|
||||
|
||||
23
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
23
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
@@ -8,14 +8,6 @@ body:
|
||||
value: |
|
||||
Please share as much detail as you can to help us understand your suggestion.
|
||||
|
||||
- type: checkboxes
|
||||
id: prerequisites
|
||||
attributes:
|
||||
label: Quick Check
|
||||
options:
|
||||
- label: I've searched existing issues and this feature hasn't been requested yet
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
@@ -57,3 +49,18 @@ body:
|
||||
- "Just sharing the idea for now"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Have You Considered Any Alternatives? (Optional)
|
||||
description: Are there other ways to achieve what you want? Tell us about them
|
||||
|
||||
- type: checkboxes
|
||||
id: prerequisites
|
||||
attributes:
|
||||
label: Before Submitting
|
||||
description: Please confirm you've completed this step
|
||||
options:
|
||||
- label: I've searched existing issues and confirmed this feature hasn't been requested yet
|
||||
required: true
|
||||
|
||||
54
.github/pull_request_template.md
vendored
54
.github/pull_request_template.md
vendored
@@ -1,35 +1,59 @@
|
||||
# 🚀 Pull Request
|
||||
## 🚀 Pull Request
|
||||
|
||||
### 📝 Description
|
||||
|
||||
## 📝 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
|
||||
|
||||
## 🛠️ Changes Implemented
|
||||
<!-- Detail the specific modifications, additions, or removals made in this pull request -->
|
||||
-
|
||||
|
||||
### 🧪 Testing Strategy
|
||||
|
||||
## 🧪 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)_
|
||||
|
||||
## 📸 Visual Changes _(if applicable)_
|
||||
<!-- Attach screenshots or videos demonstrating UI/UX modifications -->
|
||||
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Required Pre-Submission Checklist
|
||||
<!-- ⛔ Pull requests will NOT be considered for review unless ALL required items are completed -->
|
||||
<!-- All items below are MANDATORY prerequisites for submission -->
|
||||
- [ ] Code adheres to project style guidelines and conventions
|
||||
- [ ] Branch synchronized with latest `develop` branch
|
||||
- [ ] Automated unit/integration tests added/updated to cover changes
|
||||
- [ ] All tests pass locally (`./gradlew test` for backend)
|
||||
- [ ] Manual testing completed in local development environment
|
||||
- [ ] Flyway migration versioning follows correct sequence _(if database schema modified)_
|
||||
- [ ] 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)_
|
||||
|
||||
### **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/integration tests added/updated to cover changes** _(MANDATORY for ALL backend changes - this is non-negotiable)_
|
||||
- [ ] **🚨 CRITICAL: All tests pass locally** _(run `./gradlew test` for backend - 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)_
|
||||
|
||||
## 💬 Additional Context _(optional)_
|
||||
<!-- Provide any supplementary information, implementation considerations, or discussion points for reviewers -->
|
||||
|
||||
Reference in New Issue
Block a user