All pull request will be reviewed by a core developer who will manage the process of merging. It is the responsibility of a developer submitting a pull request to do their best to deliver a pull request which meets the requirements of the project it is submitted to.
The check list summarises criteria which will be checked before a pull request is merged. Before submitting a pull request please consider this list.
- Provide a helpful description of the Pull Request. This should include:
- The aim of the change / the problem addressed / a link to the issue.
- How the change has been delivered.
- Include a "What's New" entry, if appropriate. See
whats_new_contributions
. - Check all tests pass. This includes existing tests and any new tests added for any new functionality. For more information see
developer_running_tests
. - Check all modified and new source files conform to the required
code_formatting
. - Check the source documentation been updated to explain all new or changed features. See
docstrings
. - Include code examples inside the docstrings where appropriate. See
contributing.documentation.testing
. - Check the documentation builds without warnings or errors. See
contributing.documentation.building
- Check for any new dependencies in the .cirrus.yml config file.
- Check for any new dependencies in the readthedocs.yml file. This file is used to build the documentation that is served from https://scitools-iris.readthedocs.io/en/latest/
Check for updates needed for supporting projects for test or example data. For example:
- iris-test-data is a github project containing all the data to support the tests.
- iris-sample-data is a github project containing all the data to support the gallery and examples.
- test-iris-imagehash is a github project containing reference plot images to support Iris
testing.graphics
.
If new files are required by tests or code examples, they must be added to the appropriate supporting project via a suitable pull-request. This pull request should be referenced in the main Iris pull request and must be accepted and merged before the Iris one can be.