contributing: commit message format spec

Add specification for desired commit message format
This commit is contained in:
Sumner Evans
2021-05-05 09:51:30 -06:00
parent 083dfb058c
commit 3976bffe81

View File

@@ -1,6 +1,6 @@
# Contributing
Contributions are welcome! You can engane with the project in many ways:
Contributions are welcome! You can engage with the project in many ways:
* GitLab: [create an issue][glissues] or [submit a MR][glmr] on [GitLab][gl].
* Matrix: join our [Matrix chat][matrix].
@@ -148,6 +148,20 @@ $ black --check .
$ ./cicd/custom_style_check.py
```
### Commit Message Format
Commits should be reasonably self-contained, that is, each commit should make
sense in isolation. Amending and force pushing is encouraged to help maintain
this.
Commit messages should be formatted as follows:
```
{component}: {short description}
{long description}
```
### Testing
This project uses `pytest` for testing. Tests can be added in the docstrings of