From 1ba7aaa7ec4dd436d79154de3e69511064c53825 Mon Sep 17 00:00:00 2001 From: Oliver Roick Date: Wed, 14 Dec 2016 17:26:44 +0100 Subject: [PATCH 1/4] Adds PR review checklist --- .github/PULL_REQUEST_TEMPLATE | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 03b3331f0..1f3b16544 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -31,3 +31,27 @@ environments.] - - - + + +### Checklist (for reviewing) + +#### Functionality + +- [ ] **Are all requirements met?** Compare implemented functionality with the requirements specification. +- [ ] **Does the UI work as expected?** There should be no Javascript errors in the console; all resources should load. There should be no unexpected errors. Deliberately try to break the feature to find out if there are corner cases that are not handled. + +#### Code + +- [ ] **Do you fully understand the introduced changes to the code?** If not ask for clarification, it might uncover ways to solve a problem in a more elegant and efficient way. +- [ ] **Does the PR introduce any inefficient database requests?** Use the debug server to check for duplicate requests. + +#### Tests + +- [ ] **Are there sufficient test cases?** Ensure that all components are tested individually; models, forms, and serializers should be tested in isolation even if a test for a view covers these components. If this is a bug fix, there must be a test case for the bug to ensure the issue won’t regress. + + +#### Documentation + +- [ ] **Are changes to the UI documented in the platform docs?** If this PR introduces new platform site functionality or changes existing ones, the changes must be documented in the [Cadasta Platform Documentation](https://github.com/Cadasta/cadasta-docs). +- [ ] **Are changes to the API documented in the API docs?** If this PR introduces new API functionality or changes existing ones, the changes must be documented in the [API docs](https://github.com/Cadasta/api-docs). +- [ ] **Are reusable components documented?** If this PR introduces components that are relevant to other developers (for instance a mixin for a view or a generic form) they should be documented in the Wiki. From 78ae17c3618b0d321244becf712e557eb0bfcc6a Mon Sep 17 00:00:00 2001 From: Oliver Roick Date: Thu, 15 Dec 2016 09:50:09 +0100 Subject: [PATCH 2/4] Translated strings --- .github/PULL_REQUEST_TEMPLATE | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 1f3b16544..d54690e7c 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -44,6 +44,7 @@ environments.] - [ ] **Do you fully understand the introduced changes to the code?** If not ask for clarification, it might uncover ways to solve a problem in a more elegant and efficient way. - [ ] **Does the PR introduce any inefficient database requests?** Use the debug server to check for duplicate requests. +- [ ] **Are all necessary strings marked for translation?** All strings that are exposed to users via the UI must be [marked for translation](https://docs.djangoproject.com/en/1.10/topics/i18n/translation/). #### Tests From 0ea40fead305164566c53c2e0e3fe3126b11545a Mon Sep 17 00:00:00 2001 From: Oliver Roick Date: Thu, 15 Dec 2016 17:59:11 +0100 Subject: [PATCH 3/4] Add migration label --- .github/PULL_REQUEST_TEMPLATE | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index d54690e7c..234f528a3 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -3,8 +3,6 @@ [List all changes you want to add here. If you fixed an issue, please add a reference to that issue as well.] -- -- - ### When should this PR be merged @@ -18,8 +16,6 @@ can merge this pull request.] [List any risks that could arise from merging your pull request.] -- -- - ### Follow up actions @@ -29,12 +25,14 @@ migrations, software that we need to install on staging and production environments.] - -- -- ### Checklist (for reviewing) +#### General + +- [ ] **Is the PR labeled correctly?** It should have the `migration` label if a new migration is added. + #### Functionality - [ ] **Are all requirements met?** Compare implemented functionality with the requirements specification. From cba365ff63df6a823afe62cadfd32fca1ce2c396 Mon Sep 17 00:00:00 2001 From: Oliver Roick Date: Fri, 16 Dec 2016 10:14:39 +0100 Subject: [PATCH 4/4] Add changes requested by Lindsey --- .github/PULL_REQUEST_TEMPLATE | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 234f528a3..489934208 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -31,7 +31,9 @@ environments.] #### General +- [ ] **Is this PR explained thoroughly?** All code changes must be accounted for in the PR description. - [ ] **Is the PR labeled correctly?** It should have the `migration` label if a new migration is added. +**Is the risk level assessment sufficient?** The risks section should contain all risks that might be introduced with the PR and which actions we need to take to mitigate these risks. Possible risks are database migrations, new libraries that need to be installed or changes to deployment scripts. #### Functionality @@ -46,7 +48,8 @@ environments.] #### Tests -- [ ] **Are there sufficient test cases?** Ensure that all components are tested individually; models, forms, and serializers should be tested in isolation even if a test for a view covers these components. If this is a bug fix, there must be a test case for the bug to ensure the issue won’t regress. +- [ ] **Are there sufficient test cases?** Ensure that all components are tested individually; models, forms, and serializers should be tested in isolation even if a test for a view covers these components. +- [ ] **If this is a bug fix, are tests for the issue in place** There must be a test case for the bug to ensure the issue won’t regress. Make sure that the tests break without the new code to fix the issue. #### Documentation