Skip to content

Commit

Permalink
Update ruff config and contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mcarans committed Feb 6, 2024
1 parent 752bab3 commit 050dd2f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
10 changes: 6 additions & 4 deletions .config/ruff.toml
@@ -1,14 +1,16 @@
line-length = 79
exclude = ["_version.py"]
ignore = [
"E501" # Line too long
]

[lint]
# List of rules: https://docs.astral.sh/ruff/rules/
select = [
"E", # pycodestyle - default
"F", # pyflakes - default
"I" # isort
]
ignore = [
"E501" # Line too long
]

[isort]
[lint.isort]
known-local-folder = ["hdx"]
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -21,14 +21,13 @@ you make a git commit:
pre-commit install

The configuration file for this project is in a
non-start location. Thus, you will need to edit your
non-standard location. Thus, you will need to edit your
`.git/hooks/pre-commit` file to reflect this. Change
the line that begins with `ARGS` to:

ARGS=(hook-impl --config=.config/pre-commit-config.yaml --hook-type=pre-commit)

With pre-commit, all code is formatted according to
[black]("https://github.com/psf/black") and
[ruff]("https://github.com/charliermarsh/ruff") guidelines.

To check if your changes pass pre-commit without committing, run:
Expand All @@ -41,7 +40,7 @@ To run the tests and view coverage, execute:

pytest -c .config/pytest.ini --cov hdx --cov-config .config/coveragerc

Follow the example set out already in ``api.rst`` as you write the documentation.
Follow the example set out already in ``documentation/main.md`` as you write the documentation.

## Packages

Expand Down

0 comments on commit 050dd2f

Please sign in to comment.