From 9ceab0db8ab0add701240cfefac4456933d61bf9 Mon Sep 17 00:00:00 2001 From: Bart6114 Date: Tue, 10 Sep 2024 14:52:30 +0200 Subject: [PATCH] chore: Update project setup and workflows in README --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c3cfd77..dda3f19 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,11 @@ This boilerplate project contains the following setup ready for you to go. * `ruff` (triggered by `rye`) * testing framework * `pytest` (triggered by `rye`) + * see `tests` directory * type checking * `mypy` -* configured pre-commit hooks +* pre-commit hooks +* GitHub Actions workflow in `.github/workflows` This boilerplate prefers a [src layout](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/) over a flat layout. @@ -23,5 +25,6 @@ This boilerplate prefers a [src layout](https://packaging.python.org/en/latest/d 2. `pre-commit install` 3. Optionally run `pre-commit run --all-files` (this will be triggered automatically on each commit) 4. On each `git commit` the code validation packages will be run before the actual commit. -5. Explore the setup in the folder structure of this package. -6. Profit. +5. GitHub Action workflows will be triggered on `push` and `pull_request` events. +6. Explore the setup in the folder structure of this package. +7. Profit.