yujunjun/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2025-06-26 22:00:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: correcting CONTRIBUTING hatch commands (#7963)

Browse Source 
* fixing CONTRIBUTING hatch commands

* updating CONTRIBUTING.MD

* Update CONTRIBUTING.md

Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>

---------

Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>
This commit is contained in:
David S. Batista 2024-07-03 10:59:21 +02:00 committed by GitHub
parent 186512459d
commit a67872e7a8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 29 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
CONTRIBUTING.md
View File

@ -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 hatch run test:unit test/test_logging.py::TestSkipLoggingConfiguration::test_skip_logging_configuration
``` ```
We also use tools to ensure consistent code style, quality, and static type checking. The quality of your code will be ### Run code quality checks locally
tested by the CI, but once again, running the checks locally will speed up the review cycle. To check your code you
can run:
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 type checking, run:
```sh ```sh
hatch run test:lint hatch run test:type
``` ```
To check your code format run:
```sh
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: If the linters spot any error, you can fix it before checking in your code:
```sh ```sh
hatch run test:lint-fix hatch run fix
``` ```
## Requirements for Pull Requests ## Requirements for Pull Requests
To ease the review process, please follow the instructions in this paragraph when creating a Pull Request: To ease the review process, please follow the instructions in this paragraph when creating a Pull Request: