The template for `.pre-commit-config.yaml` has been updated

Open Beginner friendly
#7,231 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Quiet
Tech stack
python
Domain
tooling

Research direction

Compare .pre-commit-config.yaml in this repository with templates/.pre-commit-config.yaml in the SciTools/.github repository, starting with the supplied diff. Apply the appropriate shared changes, or close the issue if none fit; done means the repository configuration reflects the accepted template changes and the full diff has been reviewed.

Written by the indexing model from the issue text.

Description

Templating

The template for .pre-commit-config.yaml has been updated; see the diff below. Please either:

  • Action this issue with a pull request applying some/all of these changes to .pre-commit-config.yaml[^1].
  • Close this issue if none of these changes are appropriate for this repo.

Also consider reviewing a full diff between the template and .pre-commit-config.yaml, in case other valuable shared conventions have previously been missed.

File Links

Diff

diff --git a/templates/.pre-commit-config.yaml b/templates/.pre-commit-config.yaml
index 2acfb31..8789a65 100644
--- a/templates/.pre-commit-config.yaml
+++ b/templates/.pre-commit-config.yaml
@@ -13,7 +13,7 @@ ci:
 # Alphabetised, for lack of a better order.
 files: |
     (?x)(
-        .github\/workflows\/.*|
+        .github\/.*|
         benchmarks\/.+\.py|
         docs\/.+\.py|
         lib\/.+\.py|

[^1]: Include this text in the PR body to avoid any prompts about applying your changes back to the template!
@scitools-templating: please no share prompt

Dominant language
Python
Stars
724
Forks
317
Avg merge
3d 20h
Merged PRs (30d)
9

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SciTools/iris

All issues in SciTools/iris

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.