Skip to content

Commit

Permalink
Update the documentation for commands with pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
klaasnicolaas committed Jun 1, 2024
1 parent 2187daf commit fe3897b
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,12 +131,34 @@ poetry shell
exit
```

Setup the pre-commit check, you must run this inside the virtual environment:

```bash
pre-commit install
```

*Now you're all set to get started!*

As this repository uses the [pre-commit][pre-commit] framework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:

```bash
poetry run pre-commit run --all-files
```

To run just the Python tests:

```bash
poetry run pytest
```

To update the [syrupy](https://github.com/tophat/syrupy) snapshot tests:

```bash
poetry run pytest --snapshot-update
```

## License

MIT License
Expand Down Expand Up @@ -181,4 +203,5 @@ SOFTWARE.
[last-commit-shield]: https://img.shields.io/github/last-commit/home-assistant-libs/forecast_solar.svg?style=for-the-badge

[poetry-install]: https://python-poetry.org/docs/#installation
[poetry]: https://python-poetry.org
[poetry]: https://python-poetry.org
[pre-commit]: https://pre-commit.com

0 comments on commit fe3897b

Please sign in to comment.