From 84d4cc894564ea85ea7e34c3e8b747e74483f114 Mon Sep 17 00:00:00 2001 From: Javier Vegas-Regidor Date: Fri, 5 Feb 2021 11:48:10 +0100 Subject: [PATCH 1/2] Add checkbox in PR template to assign labels --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 06176963aa..0d08d325d1 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -25,6 +25,7 @@ ## Checklist - [ ] PR has a descriptive title for the [changelog](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/contributing.html#branches-pull-requests-and-code-review) +- [ ] Labels are assigned - [ ] Code follows the [style guide](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/contributing.html#code-style) - [ ] [Documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/contributing.html#documentation) is available for new functionality - [ ] YAML files pass [`pre-commit`](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/contributing.html#pre-commit) or [`yamllint`](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/community/introduction.html#yaml) checks From 03957b25b1e924c2e1f4bf2aeac97148a4e53c1a Mon Sep 17 00:00:00 2001 From: Javier Vegas-Regidor Date: Fri, 5 Feb 2021 12:17:42 +0100 Subject: [PATCH 2/2] Updated doc --- .github/pull_request_template.md | 2 +- doc/contributing.rst | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0d08d325d1..92cc2e7a0e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -25,7 +25,7 @@ ## Checklist - [ ] PR has a descriptive title for the [changelog](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/contributing.html#branches-pull-requests-and-code-review) -- [ ] Labels are assigned +- [ ] Labels are assigned so they can be used in the [changelog](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/contributing.html#branches-pull-requests-and-code-review) - [ ] Code follows the [style guide](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/contributing.html#code-style) - [ ] [Documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/contributing.html#documentation) is available for new functionality - [ ] YAML files pass [`pre-commit`](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/contributing.html#pre-commit) or [`yamllint`](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/community/introduction.html#yaml) checks diff --git a/doc/contributing.rst b/doc/contributing.rst index 5368051a80..a45b7fd030 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -227,6 +227,11 @@ early, as this will cause CircleCI to run the unit tests and Codacy to analyse your code. It’s also easier to get help from other developers if your code is visible in a pull request. +You also must assign at least one `label `__ +to it as they are used to organize the changelog. At least one of the following +ones must be used: `bug`, `deprecated feature`, `fix for dataset`, +`preprocessor`, `cmor`, `api`, `testing`, `documentation` or `enhancement`. + You can view the results of the automatic checks below your pull request. If one of the tests shows a red cross instead of a green approval sign, please click the link and try to solve the issue. Note