Skip to content

Commit

Permalink
docs: correcting CONTRIBUTING hatch commands (#7963)
Browse files Browse the repository at this point in the history
* fixing CONTRIBUTING hatch commands

* updating CONTRIBUTING.MD

* Update CONTRIBUTING.md

Co-authored-by: Silvano Cerza <[email protected]>

---------

Co-authored-by: Silvano Cerza <[email protected]>
  • Loading branch information
davidsbatista and silvanocerza authored Jul 3, 2024
1 parent 1865124 commit a67872e
Showing 1 changed file with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,20 +222,43 @@ options you would normally pass to `pytest`, for example:
hatch run test:unit test/test_logging.py::TestSkipLoggingConfiguration::test_skip_logging_configuration
```

### Run code quality checks locally

We also use tools to ensure consistent code style, quality, and static type checking. The quality of your code will be
tested by the CI, but once again, running the checks locally will speed up the review cycle. To check your code you
can run:
tested by the CI, but once again, running the checks locally will speed up the review cycle.


To check your code type checking, run:
```sh
hatch run test:lint
hatch run test:type
```

If the linters spot any error, you can fix it before checking in your code:

To check your code format run:
```sh
hatch run test:lint-fix
hatch run format-check
```


To format your code, you can run:
```sh
hatch run format
````


To check your code style according to linting rules run:
```sh
hatch run check
hatch run test:lint
````
If the linters spot any error, you can fix it before checking in your code:
```sh
hatch run fix
```


## Requirements for Pull Requests

To ease the review process, please follow the instructions in this paragraph when creating a Pull Request:
Expand Down

0 comments on commit a67872e

Please sign in to comment.