diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e31fbb7..480571f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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