Apply suggestions from code review
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
This commit is contained in:
parent
fd7569393b
commit
dc9c455979
23
.github/PULL_REQUEST_TEMPLATE.md
vendored
23
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -1,22 +1,25 @@
|
||||||
##### Motivation for the changes
|
# Motivation
|
||||||
|
<!-- Briefly explain what the change is about and why it is desirable. -->
|
||||||
|
|
||||||
<!-- An issue reference or explanation why the change is desirable. -->
|
# Context
|
||||||
<!-- This speeds up step 1 of the process. -->
|
<!-- Provide context. Reference open issues if available. -->
|
||||||
|
|
||||||
|
<!-- Non-trivial change: Briefly outline the implementation strategy. -->
|
||||||
|
|
||||||
|
<!-- Invasive change: Discuss alternative designs or approaches you considered. -->
|
||||||
|
|
||||||
|
<!-- Large change: Provide instructions to reviewers how to read the diff. -->
|
||||||
|
|
||||||
|
# Checklist for maintainers
|
||||||
|
|
||||||
##### Checklist for maintainers
|
|
||||||
|
|
||||||
<!-- Contributors: please leave this as is -->
|
<!-- Contributors: please leave this as is -->
|
||||||
<!-- Maintainers: tick if completed or explain if not relevant -->
|
<!-- Maintainers: tick if completed or explain if not relevant -->
|
||||||
|
|
||||||
- [ ] is the idea good? has it been discussed by the Nix team?
|
- [ ] agreed on idea
|
||||||
|
- [ ] agreed on implementation strategy
|
||||||
- [ ] unit tests
|
- [ ] unit tests
|
||||||
- [ ] functional tests (`tests/**.sh`)
|
- [ ] functional tests (`tests/**.sh`)
|
||||||
- [ ] documentation in the manual
|
- [ ] documentation in the manual
|
||||||
- [ ] documentation in the code (if necessary; ideally code is already clear)
|
- [ ] code and comments are self-explanatory
|
||||||
- [ ] documentation in the commit message (why was this change made? for future reference when maintaining the code)
|
- [ ] commit message explains why the change was made
|
||||||
- [ ] documentation in the changelog (to announce features and fixes to existing users who might have to do something to finally solve their problem, and to summarize the development history)
|
- [ ] new feature or bug fix: updated release notes
|
||||||
|
|
Loading…
Reference in a new issue