summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorLinus Färnstrand <linus@mullvad.net>2018-04-10 12:55:52 +0200
committerLinus Färnstrand <linus@mullvad.net>2018-04-10 12:55:52 +0200
commitbd6fd1a6905d15c27520479219b53d6dfc68aead (patch)
tree4149b635c83e4d67d7465e2e541f85b72db16083
parent2958469324ab2df05c2f6ed12dbe250813ead6b9 (diff)
parent04ea26534e4ae85c2695a74df0635736e7bec5bf (diff)
downloadmullvadvpn-bd6fd1a6905d15c27520479219b53d6dfc68aead.tar.xz
mullvadvpn-bd6fd1a6905d15c27520479219b53d6dfc68aead.zip
Merge branch 'add-changelog-instructions'
-rw-r--r--CHANGELOG.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 34a18a972a..cdba807db5 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.
@@ -26,6 +35,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Daemon now fetches latest app versions and verifies whether the current
version is supported.
- Add `version` subcommand in the CLI to show information about current versions.
+
+### Changed
- Change all occurrences of "MullvadVPN" into "Mullvad VPN", this affects
paths and window captions etc.