Skip to content

Simplify pull request checklist#7096

Merged
ESadek-MO merged 11 commits into
SciTools:mainfrom
trexfeathers:contributing
Jun 17, 2026
Merged

Simplify pull request checklist#7096
ESadek-MO merged 11 commits into
SciTools:mainfrom
trexfeathers:contributing

Conversation

@trexfeathers

@trexfeathers trexfeathers commented May 22, 2026

Copy link
Copy Markdown
Contributor

Description

  • Simplifies the pull request checklist
  • Moves the pull request checklist directly into the pull request template (see below) - to make it more immediate and therefore easier to follow
  • Updates several related pages with more detailed guidance on contributing

Checklist

(In addition to a full set of passing checks ✅)


Tip

Add any of the below labels to trigger actions on this PR:

  • benchmark_this Request that this pull request be benchmarked to check if it introduces performance shifts

scitools-ci[bot]
scitools-ci Bot previously requested changes May 22, 2026

@scitools-ci scitools-ci Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Footnotes

  1. 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

codecov Bot commented May 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.15%. Comparing base (76cf13e) to head (01fbd2c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7096   +/-   ##
=======================================
  Coverage   90.15%   90.15%           
=======================================
  Files          91       91           
  Lines       24977    24977           
  Branches     4684     4684           
=======================================
  Hits        22518    22518           
  Misses       1682     1682           
  Partials      777      777           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread docs/src/developers_guide/documenting/whats_new_contributions.rst
Comment thread docs/src/developers_guide/contributing_pull_request_checklist.rst
Comment thread docs/src/developers_guide/contributing_pull_request_checklist.rst
Comment thread docs/src/developers_guide/contributing_pull_request_checklist.rst
Comment thread docs/src/developers_guide/contributing_pull_request_checklist.rst
Comment thread docs/src/developers_guide/contributing_pull_request_checklist.rst
Comment thread docs/src/developers_guide/contributing_pull_request_checklist.rst
Comment thread docs/src/developers_guide/contributing_pull_request_checklist.rst
Comment thread docs/src/developers_guide/contributing_code_formatting.rst
Comment thread benchmarks/README.md
@trexfeathers

Copy link
Copy Markdown
Contributor Author

...
This PR includes changes that may be worth sharing via templating. For each file listed below, please either:
...

See SciTools/.github#264

@ESadek-MO ESadek-MO self-assigned this May 22, 2026
Comment thread .github/pull_request_template.md

@ESadek-MO ESadek-MO left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread .github/pull_request_template.md
Comment thread docs/src/developers_guide/documenting/whats_new_contributions.rst
Comment thread docs/src/developers_guide/contributing_code_formatting.rst Outdated

@ESadek-MO ESadek-MO left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @trexfeathers, lets get this in.

@ESadek-MO ESadek-MO dismissed scitools-ci[bot]’s stale review June 17, 2026 15:46

Minor and irrelevant

@ESadek-MO ESadek-MO merged commit 3f0dd8d into SciTools:main Jun 17, 2026
22 checks passed
tkknight added a commit to tkknight/iris that referenced this pull request Jun 18, 2026
* upstream/main:
  Simplify pull request checklist (SciTools#7096)
  docs: tighten temporal coordinates explanation (SciTools#7159)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants