diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..96595d44 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,65 @@ +## Pull Requests + +Thanks for helping to improve Shairport Sync. This template is an effort to make a Pull Request as trouble-free and useful as possible. + +## ⚠️ Important: Target Branch + +**Please ensure your pull request targets the `development` branch, not `master`.** + +Contributions should be submitted against the `development` branch for review and testing before they are merged into the main release branch. + +--- + +## Description + +Please provide a brief description of your changes: + + + +## Type of Change + +Please delete options that are not relevant: + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update +- [ ] Code refactoring +- [ ] Performance improvement +- [ ] Build/CI configuration change + +## Related Issue + +If this PR addresses an existing issue, please link it here: + +Fixes #(issue number) + +## Testing + +Please describe the tests you ran to verify your changes: + +- [ ] Tested on Linux +- [ ] Tested on FreeBSD +- [ ] Tested on OpenBSD +- [ ] Tested with AirPlay 2 +- [ ] Tested with classic AirPlay + +**Test Configuration:** +* Hardware/Platform: +* OS Version: +* Build flags used: + +## Checklist + +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation (if applicable) +- [ ] My changes generate no new warnings +- [ ] I have tested my changes and verified they work as expected +- [ ] I have checked that my PR targets the `development` branch + +## Additional Notes + +Any additional information, context, or screenshots that would help reviewers understand your changes: + +