From fd7569393bae53e8203bbbada59bb171ba7a70ed Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Tue, 10 Jan 2023 22:50:56 +0100 Subject: [PATCH 1/4] .github: Add pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..1625b9366 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +##### Motivation for the changes + + + + + + + + + +##### Checklist for maintainers + + + + + - [ ] is the idea good? has it been discussed by the Nix team? + - [ ] unit tests + - [ ] functional tests (`tests/**.sh`) + - [ ] documentation in the manual + - [ ] documentation in the code (if necessary; ideally code is already clear) + - [ ] documentation in the commit message (why was this change made? for future reference when maintaining the code) + - [ ] 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) From dc9c45597950a9eec5630c796af0d2ddb8e608a5 Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Sat, 14 Jan 2023 11:22:57 +0100 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Valentin Gagarin --- .github/PULL_REQUEST_TEMPLATE.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1625b9366..6ec1c4b5a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,22 +1,25 @@ -##### Motivation for the changes +# Motivation + - - +# Context + + + + - - -##### Checklist for maintainers +# Checklist for maintainers - - [ ] is the idea good? has it been discussed by the Nix team? + - [ ] agreed on idea + - [ ] agreed on implementation strategy - [ ] unit tests - [ ] functional tests (`tests/**.sh`) - [ ] documentation in the manual - - [ ] documentation in the code (if necessary; ideally code is already clear) - - [ ] documentation in the commit message (why was this change made? for future reference when maintaining the code) - - [ ] 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) + - [ ] code and comments are self-explanatory + - [ ] commit message explains why the change was made + - [ ] new feature or bug fix: updated release notes From 7f04a542142df7d20e46ca36abe408a965dcffe5 Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Fri, 20 Jan 2023 13:56:14 +0100 Subject: [PATCH 3/4] Update .github/PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6ec1c4b5a..d903b8aaa 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -13,7 +13,8 @@ # Checklist for maintainers - + +Maintainers: tick if completed or explain if not relevant - [ ] agreed on idea - [ ] agreed on implementation strategy From dfbdde6d07ebb9a4d637221881d93a485f39714c Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Fri, 20 Jan 2023 14:06:46 +0100 Subject: [PATCH 4/4] Update .github/PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d903b8aaa..a268d7caf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -18,8 +18,10 @@ Maintainers: tick if completed or explain if not relevant - [ ] agreed on idea - [ ] agreed on implementation strategy - - [ ] unit tests - - [ ] functional tests (`tests/**.sh`) + - [ ] tests, as appropriate + - functional tests - `tests/**.sh` + - unit tests - `src/*/tests` + - integration tests - [ ] documentation in the manual - [ ] code and comments are self-explanatory - [ ] commit message explains why the change was made