mirror of
https://github.com/torrentpier/torrentpier
synced 2025-07-05 12:36:12 -07:00
feat: add pull request template for improved contribution guidelines (#2022)
- Introduced a new PULL_REQUEST_TEMPLATE.md to standardize the information provided in pull requests. - The template includes sections for describing the purpose of the PR, changes made, testing instructions, and documentation updates. This addition aims to enhance clarity and consistency in contributions, making it easier for maintainers to review and understand changes.
This commit is contained in:
parent
5d5b907207
commit
48a17c47c6
1 changed files with 49 additions and 0 deletions
49
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
49
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,49 @@
|
|||
## 🚀 What’s this Pull Request?
|
||||
|
||||
Please describe the purpose and context of this PR. Is it a bugfix, a feature, a refactor, or maintenance?
|
||||
|
||||
- Type:
|
||||
- [ ] Bugfix
|
||||
- [ ] Feature
|
||||
- [ ] Refactor
|
||||
- [ ] Chore
|
||||
- [ ] Other
|
||||
- Related Issue(s): Closes #XXXX, Implements #XXXX
|
||||
|
||||
## ✅ What’s Changed?
|
||||
|
||||
Briefly summarize the changes you’ve made.
|
||||
|
||||
- ...
|
||||
- ...
|
||||
- ...
|
||||
|
||||
## 🔬 How to Test
|
||||
|
||||
Describe how a maintainer or reviewer can manually verify your changes.
|
||||
|
||||
1. ...
|
||||
2. ...
|
||||
3. ...
|
||||
|
||||
## 🧪 Tests
|
||||
|
||||
- [ ] Unit tests added or updated
|
||||
- [ ] No tests needed
|
||||
- [ ] Not applicable
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
- [ ] Updated relevant docs
|
||||
- [ ] No docs needed
|
||||
- [ ] Not applicable
|
||||
|
||||
## 💡 Additional Notes
|
||||
|
||||
- Compatibility concerns? (e.g., PHP version, tracker behavior, database migrations)
|
||||
- Any known limitations?
|
||||
- Anything reviewers should pay special attention to?
|
||||
|
||||
## 📸 UI / Frontend Changes (if applicable)
|
||||
|
||||
_Add screenshots, videos, or gif demos if you made UI changes._
|
Loading…
Add table
Add a link
Reference in a new issue