10-compose-add-conventional-commits #11

Merged
hygienic-books merged 9 commits from 10-compose-add-conventional-commits into master 2023-10-08 15:29:43 +00:00
Showing only changes of commit e6b8f35906 - Show all commits

View File

@ -111,3 +111,27 @@ build-context/
``` ```
When done head back up to [How to run](#how-to-run). When done head back up to [How to run](#how-to-run).
# Development
## Conventional commits
This project uses [Conventional Commits](https://www.conventionalcommits.org/) for its commit messages.
### Commit types
Commit _types_ besides `fix` and `feat` are:
- `refactor`: Keeping functionality while streamlining or otherwise improving function flow
- `docs`: Documentation for project or components
### Commit scopes
The following _scopes_ are known for this project. A Conventional Commits commit message may optionally use one of the following scopes or none:
- `grafana`: A change to how the `grafana` service component works
- `nginx`: A change to how the `nginx` service component works
- `build`: Build-related changes such as `Dockerfile` fixes and features.
- `mount`: Volume or bind mount-related changes.
- `net`: Networking, IP addressing, routing changes
- `meta`: Affects the project's repo layout, file names etc.