From e4d39d795834919c6f741eb833fa606982da67fc Mon Sep 17 00:00:00 2001 From: mcarans Date: Wed, 20 Mar 2024 14:20:29 +1300 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5bb4eb..06074b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,15 +21,14 @@ 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. +[ruff](https://github.com/astral-sh/ruff) guidelines. To check if your changes pass pre-commit without committing, run: @@ -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