Skip to content

Commit

Permalink
chore: clarify isort and pre-commit in readme (DEV-2781) (#549)
Browse files Browse the repository at this point in the history
  • Loading branch information
jnussbaum committed Oct 5, 2023
1 parent ab65608 commit e58fec1
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Expand Up @@ -169,6 +169,7 @@ We use the following linters:
- [Black](https://pypi.org/project/black/) (configured in `pyproject.toml`)
- [mypy](https://pypi.org/project/mypy/) (configured in `pyproject.toml`)
- [pylint](https://pypi.org/project/pylint/) (configured in `pyproject.toml`)
- [isort](https://pypi.org/project/isort/) (configured in `pyproject.toml`)
- [darglint](https://pypi.org/project/darglint/) (configured in `.darglint`)

These linters are integrated in the GitHub CI pipeline,
Expand All @@ -177,6 +178,8 @@ so that every pull request is checked for code style violations.
In addition, there are [pre-commit hooks](#pre-commit-hooks)
that run Black and MarkdownLint locally before every commit.
This prevents you from committing code style violations.
Pre-commit is contained in the dependencies,
but before the first use, the hooks must be installed with `pre-commit install`

Your code can be checked for style violations locally before they are committed.
Depending on your IDE the installation is as follows.
Expand Down

0 comments on commit e58fec1

Please sign in to comment.