From 0dae758258a4d8175212e2e63ea41090688e4341 Mon Sep 17 00:00:00 2001 From: danny-lloyd Date: Wed, 25 Sep 2024 17:40:28 +0100 Subject: [PATCH 1/3] Fix typos and command in CONTRIBUTING.md Command for setting up pre-commit hooks was the wrong way round --- CONTRIBUTING.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dfc4bfe..d849798 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,14 +11,14 @@ feel free to create one. Begin by collecting the repo from [GitHub](https://github.com/ESGF/esgf-playground-utils). -To contribute, you should be using `poetry` as your python package +To contribute, you should be using `poetry` as your Python package manager, see for installation instructions. -Please wnsure that when you add or update dependencies, you use the +Please ensure that when you add or update dependencies, you use the `poetry add` or `poetry add --group ` command to do so. If you do not, it is likely that the CI will reject your change. Once you have poetry installed, you should install the library with all -it’s dependencies: +its dependencies: ``` shell foo@bar:~$ poetry install @@ -27,23 +27,23 @@ foo@bar:~$ poetry install Then, activate the `pre-commit hooks` run: ``` shell -foo@bar:~$ poetry run install pre-commit +foo@bar:~$ poetry run pre-commit install ``` When you commit, the following checks will be run: - poetry-check (checks the conformity of the pyproject.toml and poetry.lock file - **this can modify the lock file in place, which can then be - commited**) + committed**) - poetry-lock (ensures an up-to-date lock file - **this can modify the lock file - in place, which can then be commited**) -- black (python style formatter - **fixes issues in place, which can then be - commited**) -- isort (python import order checker - **fixes issues in place, which can then be - commited**) -- ruff linter (python linter) -- mypy (python static type analysis) -- bandit (python SAST analyis) + in place, which can then be committed**) +- black (Python style formatter - **fixes issues in place, which can then be + committed**) +- isort (Python import order checker - **fixes issues in place, which can then be + committed**) +- ruff linter (Python linter) +- mypy (Python static type analysis) +- bandit (Python SAST analyis) - xenon (McCabe cyclomatc complexity analysis) - sphinx (dry-run documentation build) @@ -65,4 +65,4 @@ push plus the following additional checks: - audit (checks all dependencies for vulnerabilities) -Note, that no fixes in place are performed on the CI. \ No newline at end of file +Note, that no fixes in place are performed on the CI. From 31d89644d46dbafe72620538cec0636d6b2b06e1 Mon Sep 17 00:00:00 2001 From: danny-lloyd Date: Thu, 26 Sep 2024 09:50:29 +0100 Subject: [PATCH 2/3] Update authors --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 0d0263d..a103a80 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ authors = [ "David Poulter ", "Rhys Evans ", "Ed Borthwick ", + "Danny Lloyd " ] readme = "README.rst" From c7d9ca6b8d3130eaac075a682a5c50cba217aa98 Mon Sep 17 00:00:00 2001 From: danny-lloyd Date: Thu, 26 Sep 2024 09:51:20 +0100 Subject: [PATCH 3/3] Fix typo in pull request template --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index fdf5948..8a81561 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,7 +5,7 @@ ### Quality checks: -* [ ] Have you updates the **CHANGELOG.rst** file? +* [ ] Have you updated the **CHANGELOG.rst** file? * [ ] Have you updated the `version` and `author` attributes (as appropriate) in the **pyproject.toml** file? ### Community standards: @@ -19,4 +19,4 @@ The purpose of this change is to... ### What does the change consist of? -This change consists of... \ No newline at end of file +This change consists of...