mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2025-12-07 01:26:11 -08:00
Add Pull Request templates
Add code pr template and docs pr template for conformity.
This commit is contained in:
53
.github/PULL_REQUEST_TEMPLATE/code-pr-template.md
vendored
Normal file
53
.github/PULL_REQUEST_TEMPLATE/code-pr-template.md
vendored
Normal file
@@ -0,0 +1,53 @@
|
||||
## 📌 Description
|
||||
|
||||
<!-- Provide a brief description of the changes you're introducing. Be clear and concise. -->
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Related Issues
|
||||
|
||||
<!-- Reference any related issues (e.g., closes #123, fixes #456) -->
|
||||
|
||||
---
|
||||
|
||||
## 📋 Type of Change
|
||||
|
||||
Please check the relevant option(s):
|
||||
|
||||
- [ ] 🐛 Bug fix
|
||||
- [ ] ✨ New feature
|
||||
- [ ] ♻️ Code refactor
|
||||
- [ ] 📚 Documentation update
|
||||
- [ ] 🧪 Test addition or change
|
||||
- [ ] 🔧 Build/config update
|
||||
- [ ] 🚀 Performance improvement
|
||||
- [ ] 🔨 CI/CD or automation
|
||||
- [ ] 🧹 Cleanup / chore
|
||||
|
||||
---
|
||||
|
||||
## 📷 Screenshots or Logs (if applicable)
|
||||
|
||||
<!-- Add screenshots, terminal output, logs, or anything that helps understand your change -->
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Testing Steps
|
||||
|
||||
<!-- Describe how the change was tested. Manual steps, test cases, or automated test runs -->
|
||||
|
||||
---
|
||||
|
||||
## ✅ Checklist
|
||||
|
||||
- [ ] I have read the [Contribution Guidelines](https://github.com/jokob-sk/NetAlertX/blob/main/docs/CONTRIBUTING.md)
|
||||
- [ ] I have tested my changes locally
|
||||
- [ ] I have updated relevant documentation (if applicable)
|
||||
- [ ] I have verified my changes do not break existing behavior
|
||||
- [ ] I am willing to respond to requested changes and feedback
|
||||
|
||||
---
|
||||
|
||||
## 🙋 Additional Notes
|
||||
|
||||
<!-- Anything else you want reviewers to know? Future follow-ups? Questions? -->
|
||||
36
.github/PULL_REQUEST_TEMPLATE/docs-pr-template.md
vendored
Normal file
36
.github/PULL_REQUEST_TEMPLATE/docs-pr-template.md
vendored
Normal file
@@ -0,0 +1,36 @@
|
||||
## 📚 Documentation Update
|
||||
|
||||
<!-- Describe the purpose of this PR in one or two sentences. Example: "This PR updates the contributor guidelines by merging frontend and backend sections." -->
|
||||
|
||||
---
|
||||
|
||||
## 📝 What’s Changed?
|
||||
|
||||
<!-- Briefly outline what parts of the documentation were added, changed, removed, or reorganized -->
|
||||
|
||||
- Combined frontend and backend development guidelines into a single file
|
||||
- Updated `mkdocs.yml` to reflect new structure
|
||||
- Added clarification on contribution process
|
||||
- Fixed outdated links in sidebar
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Related Issue(s)
|
||||
|
||||
<!-- Link to related issues, discussions, or context (e.g., closes #123) -->
|
||||
|
||||
---
|
||||
|
||||
## ✅ Checklist
|
||||
|
||||
- [ ] I followed the formatting/style of existing documentation
|
||||
- [ ] I updated `mkdocs.yml` if necessary
|
||||
- [ ] I verified links and references still work
|
||||
- [ ] I checked that my changes improve clarity, structure, or accuracy
|
||||
- [ ] I'm open to feedback and suggestions
|
||||
|
||||
---
|
||||
|
||||
## 🙋 Additional Notes
|
||||
|
||||
<!-- Optional: Include anything you want reviewers to be aware of -->
|
||||
Reference in New Issue
Block a user