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 Harness. 🚀 New features to boost your workflow:
|
|
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".
There was a problem hiding this comment.
Yeah, I'd agree, I think that'd be nice. I can't think of phrasing though 😂
ESadek-MO
left a comment
ESadek-MO
left a comment
There was a problem hiding this comment.
Honestly looks great, I can't see anything controversial, which is always unsettling on documentation 😂
A couple questions, and your original suggestion to add a lifeline to the checklist for newer users, and I think it'd be good to go.
There was a problem hiding this comment.
Yeah, I'd agree, I think that'd be nice. I can't think of phrasing though 😂
| Git Conflicts | ||
| ============= | ||
| It should describe your change in a few sentences, with particular focus on | ||
| what the change means for users who might read this. For formatting guidance: |
There was a problem hiding this comment.
| what the change means for users who might read this. For formatting guidance: | |
| what the change means for users who might read this. For formatting guidance, |
Please correct me if I'm wrong, but the : feels wrong here. Alternatively, no punctuation at all
| `pre-commit`_. | ||
| ``pre-commit`` compliance is automatically checked on all Iris pull requests | ||
| (more info: :ref:`pre_commit_ci`), but you can also run pre-commit locally as | ||
| Git hooks - every time you make a commit: |
There was a problem hiding this comment.
The punctuation feels a bit janky here, but I'm realising I may just have a bias against colons.
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: