https://github.com/ESMValGroup/ESMValTool
Tip revision: 63013aca8e288f190a11ea89c1626454f8785348 authored by Stanislaus Cristo - on 14 February 2022, 13:30:58 UTC
Edited Documentation
Edited Documentation
Tip revision: 63013ac
pull_request_template.md
<!--
Thank you for contributing to our project!
Please do not delete this text completely, but read the text below and keep
items that seem relevant. If in doubt, just keep everything and add your
own text at the top, a reviewer will update the checklist for you.
While the checklist is intended to be filled in by the technical and scientific
reviewers, it is the responsibility of the author of the pull request to make
sure all items on it are properly implemented.
-->
## Description
<!--
Please describe your changes here, especially focusing on why this pull request makes
ESMValTool better and what problem it solves.
Before you start, please read our contribution guidelines: https://docs.esmvaltool.org/en/latest/community/
Please fill in the GitHub issue that is closed by this pull request, e.g. Closes #1903
-->
- Closes #issue_number
- Link to documentation:
* * *
## Before you get started
<!--
Please discuss your idea with the development team before getting started,
to avoid disappointment or unnecessary work later. The way to do this is
to open a new issue on GitHub.
-->
- [ ] [โ Create an issue](https://docs.esmvaltool.org/en/latest/community/code_documentation.html#contributing-code-and-documentation) to discuss what you are going to do
## Checklist
It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the [๐ Technical][1] or [๐งช Scientific][2] review.
<!-- The next two lines turn the ๐ and ๐งช below into hyperlinks -->
[1]: https://docs.esmvaltool.org/en/latest/community/review.html#technical-review
[2]: https://docs.esmvaltool.org/en/latest/community/review.html#scientific-review
- [ ] [๐ ][1] This pull request has a [descriptive title](https://docs.esmvaltool.org/en/latest/community/code_documentation.html#pull-request-title)
- [ ] [๐ ][1] Code is written according to the [code quality guidelines](https://docs.esmvaltool.org/en/latest/community/code_documentation.html#code-quality)
- [ ] [๐ ][1] [Documentation](https://docs.esmvaltool.org/en/latest/community/code_documentation.html#documentation) is available
- [ ] [๐ ][1] [Tests](https://docs.esmvaltool.org/en/latest/community/code_documentation.html#tests) run successfully
- [ ] [๐ ][1] The [list of authors](https://docs.esmvaltool.org/en/latest/community/code_documentation.html#list-of-authors) is up to date
- [ ] [๐ ][1] Any changed dependencies have been [added or removed correctly](https://docs.esmvaltool.org/en/latest/community/code_documentation.html#dependencies)
- [ ] [๐ ][1] All [checks below this pull request](https://docs.esmvaltool.org/en/latest/community/code_documentation.html#pull-request-checks) were successful
### [New or updated recipe/diagnostic](https://docs.esmvaltool.org/en/latest/community/diagnostic.html)
- [ ] [๐งช][2] [Recipe runs successfully](https://docs.esmvaltool.org/en/latest/community/diagnostic.html#testing-recipes)
- [ ] [๐งช][2] [Recipe is well documented](https://docs.esmvaltool.org/en/latest/community/diagnostic.html#recipe-and-diagnostic-documentation)
- [ ] [๐งช][2] [Figure(s) and data](https://docs.esmvaltool.org/en/latest/community/diagnostic.html#diagnostic-output) look as expected from literature
- [ ] [๐ ][1] [Provenance information](https://docs.esmvaltool.org/en/latest/community/diagnostic.html#recording-provenance) has been added
### [New or updated data reformatting script](https://docs.esmvaltool.org/en/latest/develop/dataset.html)
- [ ] [๐ ][1] [Documentation](https://docs.esmvaltool.org/en/latest/community/dataset.html#dataset-documentation) is available
- [ ] [๐ ][1] The dataset has been [added to the CMOR check recipe](https://docs.esmvaltool.org/en/latest/community/dataset.html#testing)
- [ ] [๐งช][2] Numbers and units of the data look [physically meaningful](https://docs.esmvaltool.org/en/latest/community/dataset.html#scientific-sanity-check)
***
To help with the number of pull requests:
- ๐ We kindly ask you to [review](https://docs.esmvaltool.org/en/latest/community/review.html#review-of-pull-requests) two other [open pull requests](https://github.com/ESMValGroup/ESMValTool/pulls) in this repository
<!--
If you need help with any of the items on the checklists above, please do not hesitate to ask by commenting in the issue or pull request.
-->