2023-01-14 10:22:57 +00:00
|
|
|
# Motivation
|
|
|
|
|
<!-- Briefly explain what the change is about and why it is desirable. -->
|
2023-01-10 21:50:56 +00:00
|
|
|
|
2023-01-14 10:22:57 +00:00
|
|
|
# Context
|
|
|
|
|
<!-- Provide context. Reference open issues if available. -->
|
2023-01-10 21:50:56 +00:00
|
|
|
|
2023-01-14 10:22:57 +00:00
|
|
|
<!-- Non-trivial change: Briefly outline the implementation strategy. -->
|
2023-01-10 21:50:56 +00:00
|
|
|
|
2023-01-14 10:22:57 +00:00
|
|
|
<!-- Invasive change: Discuss alternative designs or approaches you considered. -->
|
2023-01-10 21:50:56 +00:00
|
|
|
|
2023-01-14 10:22:57 +00:00
|
|
|
<!-- Large change: Provide instructions to reviewers how to read the diff. -->
|
2023-01-10 21:50:56 +00:00
|
|
|
|
2023-01-14 10:22:57 +00:00
|
|
|
# Checklist for maintainers
|
2023-01-10 21:50:56 +00:00
|
|
|
|
|
|
|
|
<!-- Contributors: please leave this as is -->
|
2023-01-20 12:56:14 +00:00
|
|
|
|
|
|
|
|
Maintainers: tick if completed or explain if not relevant
|
2023-01-10 21:50:56 +00:00
|
|
|
|
2023-01-14 10:22:57 +00:00
|
|
|
- [ ] agreed on idea
|
|
|
|
|
- [ ] agreed on implementation strategy
|
2023-01-20 13:06:46 +00:00
|
|
|
- [ ] tests, as appropriate
|
|
|
|
|
- functional tests - `tests/**.sh`
|
|
|
|
|
- unit tests - `src/*/tests`
|
|
|
|
|
- integration tests
|
2023-01-10 21:50:56 +00:00
|
|
|
- [ ] documentation in the manual
|
2023-01-14 10:22:57 +00:00
|
|
|
- [ ] code and comments are self-explanatory
|
|
|
|
|
- [ ] commit message explains why the change was made
|
|
|
|
|
- [ ] new feature or bug fix: updated release notes
|
