zynaddsubfx

ZynAddSubFX open source synthesizer
Log | Files | Refs | Submodules | LICENSE

commit c34507f9373ddb5d81af2ae3acb90aa7328541f9
parent 3dce9dab386a8e56ffc458ec2b5583d2064ba0eb
Author: Johannes Lorenz <1042576+JohannesLorenz@users.noreply.github.com>
Date:   Tue, 17 Dec 2024 19:19:27 +0100

Add PR template (#305)


Diffstat:
A.github/PULL_REQUEST_TEMPLATE/pr-template.md | 33+++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+), 0 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE/pr-template.md b/.github/PULL_REQUEST_TEMPLATE/pr-template.md @@ -0,0 +1,33 @@ +# Description + +(Write your PR description here) + +# Checks + +## Human checks (please check those!): + +- [ ] 01. Could parts of this PR be split into another PR (while keeping the PRs "atomic")? +- [ ] 02. Does this PR depend on another PR or does it block another PR? +- [ ] 03. Does this PR solve a known issue? +- [ ] 04. Is there sufficient user documentation in the `doc/` folder? +- [ ] 05. Is the code realtime safe? (e.g. no `new`/`delete`, no other syscalls like `sleep`/file handling/mutexes, no prints in non-error code pathways, ...) +- [ ] 06. Is aliasing avoided? +- [ ] 07. Are clicks/pops/discontinuities avoided? +- [ ] 08. Are any new parameters well mapped over their provided range? +- [ ] 09. Is divide by zero impossible? +- [ ] 10. Does the code define all magic numbers at a common place (e.g. on top of the file, or for constants which are used in several places, inside `src/globals.h`)? +- [ ] 11. Are nontrivial formulae or constants explained and the source is referenced? +- [ ] 12. Do nontrivial class variables have a doxygen comment? +- [ ] 13. Code: Are grammar and spelling correct? (Note: spell checks are only done for `doc/`) +- [ ] 14. Documentation: Is the grammar correct? (Note: spell checks are done by CI) +- [ ] 15. Are all function parameters `const` - if possible? +- [ ] 16. Are all class members `const` - if possible? +- [ ] 17. Is `memmove` avoided where a ringbuffer would be faster? +- [ ] 18. Is a unit test needed for this functionality? + +## CI checks: + +- No trailing whitespace? +- Are all included headers necessary? +- No compiler warnings? +- No spell errors in documentation? (new words must be appended to `doc/wordlist.txt`)