Skip to content

Commit

Permalink
Add instructions for running tests locally to README.md
Browse files Browse the repository at this point in the history
- Added detailed steps for running tests and checking test coverage using `pytest` and `coverage`.
- Positioned the new instructions under the "Testing" subsection within the "Contributing" section.

This update provides clear guidance for contributors to verify the functionality of the CLI tool on their local machines.
  • Loading branch information
sambhavnoobcoder authored Jul 18, 2024
1 parent 794f050 commit 6cb4e09
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,25 @@ To update the project, run the following command:
pip install pieces-cli --upgrade
```
### Testing
To discover and run all the test cases in the repository, run the following command:
```shell
pytest
```
To check the test coverage, you can use the coverage package. Install coverage with:
```shell
pip install coverage
```
Run the tests with coverage using the following command:
```shell
coverage run -m pytest
coverage report
```
### Uninstallation
To uninstall the project, run the following command:
Expand Down

0 comments on commit 6cb4e09

Please sign in to comment.