Simplify pull request checklist#7096
Conversation
![scitools-ci[bot]](https://avatars.githubusercontent.com/in/212324?s=60&v=4){kind=small}
There was a problem hiding this comment.
Templating
This PR includes changes that may be worth sharing via templating. For each file listed below, please either:
- Action the suggestion via a pull request editing/adding the relevant file in the SciTools/.github
templates/directory. 1 - Raise an issue against the SciTools/.github repo for the above action if you really don't have 10mins spare right now. Include an assignee, to avoid it being forgotten.
- Dismiss the suggestion if the changes are not suitable for templating.
You will need to dismiss this review before this PR can be merged. Recommend the reviewer does this as their final action before merging, as this text will continually update as commits come in.
Templated files
The following changed files are templated:
-
benchmarks/README.md, templated bySciTools/.github/templates/benchmarks/README.md -
benchmarks/custom_bms/README.md, templated bySciTools/.github/templates/benchmarks/custom_bms/README.md -
benchmarks/custom_bms/install.py, templated bySciTools/.github/templates/benchmarks/custom_bms/install.py -
benchmarks/custom_bms/tracemallocbench.py, templated bySciTools/.github/templates/benchmarks/custom_bms/tracemallocbench.py
Footnotes
-
Include this text in the PR body to avoid any notifications about applying the template changes back to the source repo!
@scitools-templating: please no update notification on: iris↩
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7096 +/- ##
=======================================
Coverage 90.13% 90.13%
=======================================
Files 91 91
Lines 24957 24957
Branches 4684 4684
=======================================
Hits 22496 22496
Misses 1683 1683
Partials 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
This was VERY wordy for something expected of all contributors. I didn't feel comfortable linking to it in the PR checklist. So I have separated it into a TLDR essentials, and retained the previous notes in a separate Details section.
| #. **Include a "What's New" entry**, if appropriate. | ||
| See :ref:`whats_new_contributions`. |
There was a problem hiding this comment.
Migrated to the PR template
| #. **Check all new dependencies added to the** `requirements`_ **yaml | ||
| files.** If dependencies have been added then new nox testing lockfiles | ||
| should be generated too, see :ref:`gha_test_env`. |
There was a problem hiding this comment.
Migrated to the PR template
| #. **Check the source documentation been updated to explain all new or changed | ||
| features**. Note, we now use numpydoc strings. Any touched code should | ||
| be updated to use the docstrings formatting. See :ref:`docstrings`. |
There was a problem hiding this comment.
Migrated to the PR template
| #. **Include code examples inside the docstrings where appropriate**. See | ||
| :ref:`contributing.documentation.testing`. |
There was a problem hiding this comment.
Migrated to the PR template
| #. **Check the documentation builds without warnings or errors**. See | ||
| :ref:`contributing.documentation.building` |
There was a problem hiding this comment.
NOT migrated to the PR template - this is implicitly addressed by the CI checks.
| #. **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/ |
There was a problem hiding this comment.
NOT migrated to the PR template - this is too specific to be worth calling out. The RTD build is part of the CI checks (that might not have been true when this was written), so will flag any [rare] dependency failures before the PR is merged.
| #. **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. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
NOT migrated to the PR template - this is too specific to be worth calling out. I moved the text into contributing_ci_tests.rst, and that is linked from the template, so hopefully that's enough breadcrumbs for the rare times when this point is important.
There was a problem hiding this comment.
This was written when we first introduced pre-commit, specifically to handle the black linting tool. The use has now grown, and evolves rapidly, so I made two types of change:
- Removed any out-dated information
- Rephrased to make this page less vulnerable to going out of date again
|
There was a problem hiding this comment.
@ESadek-MO we might consider some messaging in here to avoid scaring new contributors? Some form of "we can help, don't worry".
2 participants
Description
Checklist
(In addition to a full set of passing checks ✅)
Tip
Add any of the below labels to trigger actions on this PR: