diff options
| author | Linus Färnstrand <linus@mullvad.net> | 2018-04-04 14:38:28 +0200 |
|---|---|---|
| committer | Linus Färnstrand <linus@mullvad.net> | 2018-04-09 10:00:24 +0200 |
| commit | 3029e4df3d79f1756915eda26c63ed2b9133faa0 (patch) | |
| tree | 482d8686f8e9bb1b3594794f5b794fa7d911062f | |
| parent | 2958469324ab2df05c2f6ed12dbe250813ead6b9 (diff) | |
| download | mullvadvpn-3029e4df3d79f1756915eda26c63ed2b9133faa0.tar.xz mullvadvpn-3029e4df3d79f1756915eda26c63ed2b9133faa0.zip | |
Add extra formatting guidelines to changelog
| -rw-r--r-- | CHANGELOG.md | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 34a18a972a..f31ab9ecfc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,17 @@ # Changelog -All notable changes to this project will be documented in this file. +All changes to the software that can be noticed from the users' perspective should have an entry in +this file. Except very minor things that will not affect functionality, such as log message changes +and minor GUI adjustments. + +### Format The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/). +Entries should have the imperative form, just like commit messages. Start each entry with words like +add, fix, increase, force etc.. Not added, fixed, increased, forced etc. + +Line wrap the file at 100 chars. That is over here -> | + ### Categories each change fall into * **Added**: for new features. |