Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README #12

Merged
merged 1 commit into from
Apr 5, 2024
Merged

Improve README #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,12 @@ Run the application which will be listening on port `8020`.
poetry run python app.py
```
### Pre-commit hooks
The project is offering pre-commit hooks, please install them via
The project is offering [pre-commit](https://pre-commit.com/) hooks, please install them via
```console
pre-commit install
```

### GitHub Acitons
### GitHub Actions
Each commit in the main branch will trigger a pipeline which will run unit tests and different linting tools.
When successful it will also containerize the application, finally its scans the docker image for vulnerabilities with [Trivy](https://aquasecurity.github.io/trivy/v0.49/).

Expand Down