summaryrefslogtreecommitdiffhomepage
path: root/android
diff options
context:
space:
mode:
Diffstat (limited to 'android')
-rw-r--r--android/CHANGELOG.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/android/CHANGELOG.md b/android/CHANGELOG.md
new file mode 100644
index 0000000000..ba2715d5e8
--- /dev/null
+++ b/android/CHANGELOG.md
@@ -0,0 +1,22 @@
+# Android changelog
+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.
+* **Changed**: for changes in existing functionality.
+* **Deprecated**: for soon-to-be removed features.
+* **Removed**: for now removed features.
+* **Fixed**: for any bug fixes.
+* **Security**: in case of vulnerabilities.