pr-template.md (1854B)
1 # Description 2 3 (Write your PR description here) 4 5 # Checks 6 7 ## Human checks (please check those!): 8 9 - [ ] 01. Is the PR atomic? (or could parts of this PR be split into another PR) 10 - [ ] 02. Are PRs relying on or blocking this PR marked and linked in both PRs descriptions 11 - [ ] 03. Are known issues that this PR solves linked in both descriptions (PR and issue)? 12 - [ ] 04. Is there sufficient user documentation in the `doc/` folder? 13 - [ ] 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, ...) 14 - [ ] 06. Is aliasing properly avoided? 15 - [ ] 07. Are clicks/pops/discontinuities successfully avoided? 16 - [ ] 08. Are all new parameters well-mapped and behave as expected across their provided range? 17 - [ ] 09. Is divide by zero completely impossible with these changes? 18 - [ ] 10. Are all magic numbers clearly defined and centralized (local ones at the top of the file, global ones in src/globals.h)? 19 - [ ] 11. Are all nontrivial formulae or constants explained, with appropriate references provided? 20 - [ ] 12. Do nontrivial class variables have appropriate Doxygen comments? 21 - [ ] 13. Code: Are grammar and spelling correct? (Note: spell checks are only done for `doc/`) 22 - [ ] 14. Documentation: Is the grammar correct? (Note: spell checks are done by CI) 23 - [ ] 15. Are all function parameters `const` where possible? 24 - [ ] 16. Are all class members `const` where possible? 25 - [ ] 17. Is the use of `memmove` avoided in favor of more efficient alternatives like a ringbuffer when suitable? 26 - [ ] 18. Is there sufficient coverage with unit tests for this functionality? 27 28 ## CI checks: 29 30 - No trailing whitespace? 31 - Are all included headers necessary? 32 - No compiler warnings? 33 - No spell errors in documentation? (new words must be appended to `doc/wordlist.txt`)