zynaddsubfx

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

commit 17ea1d880c21cf80abe2c1bdd043e30cc871a8c4
parent c34507f9373ddb5d81af2ae3acb90aa7328541f9
Author: friedolino78 <34608315+friedolino78@users.noreply.github.com>
Date:   Sat, 28 Dec 2024 14:09:00 +0100

Clarify PR checklist (#310)


Diffstat:
M.github/PULL_REQUEST_TEMPLATE/pr-template.md | 28++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE/pr-template.md b/.github/PULL_REQUEST_TEMPLATE/pr-template.md @@ -6,24 +6,24 @@ ## 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? +- [ ] 01. Is the PR atomic? (or could parts of this PR be split into another PR) +- [ ] 02. Are PRs relying on or blocking this PR marked and linked in both PRs descriptions +- [ ] 03. Are known issues that this PR solves linked in both descriptions (PR and 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? +- [ ] 06. Is aliasing properly avoided? +- [ ] 07. Are clicks/pops/discontinuities successfully avoided? +- [ ] 08. Are all new parameters well-mapped and behave as expected across their provided range? +- [ ] 09. Is divide by zero completely impossible with these changes? +- [ ] 10. Are all magic numbers clearly defined and centralized (local ones at the top of the file, global ones in src/globals.h)? +- [ ] 11. Are all nontrivial formulae or constants explained, with appropriate references provided? +- [ ] 12. Do nontrivial class variables have appropriate Doxygen comments? - [ ] 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? +- [ ] 15. Are all function parameters `const` where possible? +- [ ] 16. Are all class members `const` where possible? +- [ ] 17. Is the use of `memmove` avoided in favor of more efficient alternatives like a ringbuffer when suitable? +- [ ] 18. Is there sufficient coverage with unit tests for this functionality? ## CI checks: