Merge pull request '10-compose-add-conventional-commits' (#11) from 10-compose-add-conventional-commits into master

Reviewed-on: #11

README.md

@@ -36,7 +36,7 @@ component_list [grafana]: grafana,nginx
 Select build:
 1 - no
 2 - yes
-Choose from 1, 2 [1]:  
+Choose from 1, 2 [1]:
 ```
 
 The end result is a directory structure that has everything you need to hit the ground running.

docker-compose/examples/grafana/README.md

@@ -13,6 +13,7 @@ Add a `COMPOSE_ENV` file and save its location as a shell variable along with th
 When everything's ready start Grafana with Docker Compose, otherwise head down to [Initial setup](#initial-setup) first.
 
 ## Environment
+
 ```
 export COMPOSE_DIR='/opt/containers/grafana'
 export COMPOSE_CTX='ux_vilnius'
@@ -111,3 +112,27 @@ 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:
+
+- `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.

docker-compose/examples/hashicorpvault/README.md

@@ -13,6 +13,7 @@ Add a `COMPOSE_ENV` file and save its location as a shell variable along with th
 When everything's ready start Vault with Docker Compose, otherwise head down to [Initial setup](#initial-setup) first.
 
 ## Environment
+
 ```
 export COMPOSE_DIR='/opt/containers/hashicorpvault'
 export COMPOSE_CTX='ux_vilnius'
@@ -30,6 +31,7 @@ docker context create fully.qualified.domain.name --docker 'host=ssh://root@full
 ```
 
 ## Build
+
 FIXME We build the `vault` image locally. Our adjustment to the official image is simply adding `/tmp/vault` to it. See [build-context/Dockerfile](build-context/Dockerfile). We use `/tmp/vault` to bind-mount a dedicated ZFS dataset for the application's `tmpdir` location.
 
 ```
@@ -107,3 +109,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.

docker-compose/{{ cookiecutter.__project_slug }}/README.md

@@ -13,6 +13,7 @@ Add a `COMPOSE_ENV` file and save its location as a shell variable along with th
 When everything's ready start {{ cookiecutter.__service_slug.capitalize() }} with Docker Compose, otherwise head down to [Initial setup](#initial-setup) first.
 
 ## Environment
+
 ```
 export COMPOSE_DIR='/opt/containers/{{ cookiecutter.__project_slug }}'
 export COMPOSE_CTX='ux_vilnius'
@@ -32,10 +33,9 @@ docker context create fully.qualified.domain.name --docker 'host=ssh://root@full
 {%- if cookiecutter.build == "yes" %}
 
 ## Build
-
 {%- set components = cookiecutter.__component_list_slug.split(',') -%}
 {% for component in components %}
-{%- if loop.first %}
+{% if loop.first %}
 FIXME We build the `{{ cookiecutter.__service_slug }}` image locally. Our adjustment to the official image is simply adding `/tmp/{{ cookiecutter.__service_slug }}` to it. See {% if ',' in cookiecutter.__component_list_slug %}[build-context/{{ cookiecutter.__service_slug }}/Dockerfile](build-context/{{ cookiecutter.__service_slug }}/Dockerfile){%- else %}[build-context/Dockerfile](build-context/Dockerfile){%- endif %}. We use `/tmp/{{ cookiecutter.__service_slug }}` to bind-mount a dedicated ZFS dataset for the application's `tmpdir` location.
 
 ```
@@ -167,3 +167,32 @@ 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:
+{%if ',' in cookiecutter.__component_list_slug -%}
+{%- set components = cookiecutter.__component_list_slug.split(',') -%}
+{%- for component in components %}
+- `{{ component }}`: A change to how the `{{ component }}` service component works
+{%- endfor -%}
+{%- else %}
+- `{{ cookiecutter.__service_slug }}`: A change to how the `{{ cookiecutter.__service_slug }}` service component works
+{%- endif %}
+- `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.