summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNadrieril2020-06-25 13:20:43 +0100
committerNadrieril2020-06-25 13:20:43 +0100
commit04227e98cbbd1ccf9625e0f5e7725f68d764ac3e (patch)
treec01736c881f47d9fcfe2ece92d5251800114a856
parentd3c746435baf5541886be549c30700a86ebe41d3 (diff)
doc: mention new commit convention in README
Diffstat (limited to '')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5cd050a..7d8aadc 100644
--- a/README.md
+++ b/README.md
@@ -165,6 +165,16 @@ The output of the ui tests is stored in the local `dhall/tests` directory, even
for the tests coming from dhall-lang. They are stored in a `.txt` file with the
same name as the corresponding test.
+### Commit messages
+
+I try to keep commit messages somewhat in the style of [Conventional
+Commits](https://www.conventionalcommits.org/en/v1.0.0). That means the commit
+message should start with `feat:`, `test:`, `doc:`, `fix:`, `style:`,
+`refactor:`, `chore:`, `perf:` or similar prefixes.
+
+A breaking change should be indicated with `!` before the `:`.
+
+
## Changelog
#### [Unreleased]