docs(meta): Add Conventional Commits paragraph (#1)

This commit is contained in:
hygienic-books 2023-10-08 18:04:43 +02:00
parent 9beeb9935f
commit 7400821800

View File

@ -123,3 +123,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:
- `nginx`: A change to how the `nginx` service component works
- `ping`: A change to how the `ping` 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.