feat(compose): Add a README.md section explaining Conventional Commits usage (#10)
This commit is contained in:
parent
96cce1634b
commit
0042adba00
@ -167,3 +167,33 @@ 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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user