From 04227e98cbbd1ccf9625e0f5e7725f68d764ac3e Mon Sep 17 00:00:00 2001 From: Nadrieril Date: Thu, 25 Jun 2020 13:20:43 +0100 Subject: doc: mention new commit convention in README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'README.md') 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] -- cgit v1.2.3