mirror of
https://github.com/booklore-app/booklore.git
synced 2026-02-18 00:17:53 +01:00
Update PR template
This commit is contained in:
52
.github/pull_request_template.md
vendored
52
.github/pull_request_template.md
vendored
@@ -1,47 +1,35 @@
|
||||
---
|
||||
name: Pull Request
|
||||
about: Submit a pull request for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
# 🚀 Pull Request
|
||||
|
||||
## 📝 Description
|
||||
<!-- Briefly describe the purpose of this pull request. What problem does it solve? -->
|
||||
<!-- Link to the related issue, if any. Ex: "Fixes #123" or "Closes #456" -->
|
||||
<!-- Provide a clear, concise description of what this PR accomplishes -->
|
||||
<!-- Reference related issues using "Fixes #123", "Closes #456", or "Relates to #789" -->
|
||||
|
||||
|
||||
## 🛠️ What's Changed?
|
||||
<!-- Provide a clear and concise summary of the changes you've made. -->
|
||||
<!-- Bullet points are great for listing multiple changes. -->
|
||||
## 🛠️ Changes Made
|
||||
<!-- Summarize the key changes in this pull request -->
|
||||
-
|
||||
|
||||
|
||||
## 🧪 How Was This Tested?
|
||||
<!-- Describe the steps you took to verify your changes work as expected. -->
|
||||
<!-- This helps reviewers understand your testing process. -->
|
||||
- [ ] Manual testing on my local machine
|
||||
- [ ] Added new unit/integration tests
|
||||
## 🧪 Testing
|
||||
<!-- Describe how you verified these changes work correctly -->
|
||||
- [ ] Tested manually in local environment
|
||||
- [ ] Added/updated automated unit/integration tests
|
||||
- [ ] All existing tests pass
|
||||
|
||||
|
||||
## 📸 Screenshots / Videos _(Optional)_
|
||||
<!-- If your changes affect the UI, please add screenshots or a short video. -->
|
||||
<!-- This makes it much easier to review visual changes. -->
|
||||
## 📸 Visual Changes _(if applicable)_
|
||||
<!-- Include screenshots or videos for UI/UX changes -->
|
||||
|
||||
|
||||
## ✅ Checklist
|
||||
<!-- Go through this checklist before submitting your PR. -->
|
||||
- [ ] I have read the **CONTRIBUTING** document.
|
||||
- [ ] My code follows the project's coding standards.
|
||||
- [ ] I have added/updated tests to cover my changes.
|
||||
- [ ] I have updated the documentation if necessary.
|
||||
- [ ] I have run `./gradlew test` successfully (for backend changes).
|
||||
- [ ] My branch is up-to-date with the `main` branch.
|
||||
- [ ] **For big features:** I have created a documentation PR at [booklore-docs](https://github.com/booklore-app/booklore-docs) with styling similar to other documentation pages.
|
||||
## ✅ Pre-submission Checklist
|
||||
<!-- Ensure all items are completed before requesting review -->
|
||||
- [ ] Code follows project style guidelines and conventions
|
||||
- [ ] Tests added/updated to cover changes
|
||||
- [ ] All tests pass locally (`./gradlew test` for backend)
|
||||
- [ ] Flyway migration versioning is correct _(if database changes made)_
|
||||
- [ ] Branch is synced with latest `develop` branch
|
||||
- [ ] Documentation PR created at [booklore-docs](https://github.com/booklore-app/booklore-docs) _(for major features)_
|
||||
|
||||
|
||||
## 📌 Additional Context _(Optional)_
|
||||
<!-- Any other information that might be helpful for reviewers? -->
|
||||
## 💬 Additional Notes _(optional)_
|
||||
<!-- Add any context, considerations, or discussion points for reviewers -->
|
||||
|
||||
Reference in New Issue
Block a user