Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos and command in CONTRIBUTING.md #19

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -19,4 +19,4 @@ The purpose of this change is to...

### What does the change consist of?

This change consists of...
This change consists of...
28 changes: 14 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://python-poetry.org> 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 <group_name>` 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
Expand All @@ -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)

Expand All @@ -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.
Note, that no fixes in place are performed on the CI.
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ authors = [
"David Poulter <[email protected]>",
"Rhys Evans <[email protected]>",
"Ed Borthwick <[email protected]>",
"Danny Lloyd <[email protected]>"
]
readme = "README.rst"

Expand Down