From 6c08ba37c619698a89aa6ea0199e52e5604b83a4 Mon Sep 17 00:00:00 2001 From: hygienic-books Date: Sun, 8 Oct 2023 17:23:11 +0200 Subject: [PATCH] feat(compose): Update Vault example with Conventional commits paragraph (#10) --- .../examples/hashicorpvault/README.md | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docker-compose/examples/hashicorpvault/README.md b/docker-compose/examples/hashicorpvault/README.md index d23dfa2..c6451a0 100644 --- a/docker-compose/examples/hashicorpvault/README.md +++ b/docker-compose/examples/hashicorpvault/README.md @@ -107,3 +107,26 @@ build-context/ ``` 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: + +- `vault`: A change to how the `vault` 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.