nix-super/.github/PULL_REQUEST_TEMPLATE.md

29 lines
942 B
Markdown
Raw Normal View History

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