diff options
| author |  Jeremie Guichard <djebrest@gmail.com> | 2018-04-07 07:38:19 +0200 |
|---|---|---|
| committer |  Dirk Hohndel <dirk@hohndel.org> | 2018-04-07 11:36:41 -0700 |
| commit | d64c48855df647cc4d80fba6874ae6f89511f7d3 (patch) | |
| tree | 4c0bb7e3812b55215fa73d0c80f3ba2951b942ea | |
| parent | 68ef735bde1acbe663a8ba8436a356f1309829d1 (diff) | |
| download | subsurface-d64c48855df647cc4d80fba6874ae6f89511f7d3.tar.gz | |
Add section describing use of CHANGELOG.md in CONTRIBUTING.md
Add description about file format
Add list of Areas that can be used
Signed-off-by: Jeremie Guichard <djebrest@gmail.com>
| -rw-r--r-- | CONTRIBUTING.md | 24 |
1 files changed, 21 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e13cb912..a82a797f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,6 +54,27 @@ https://en.wikipedia.org/wiki/Imperative_mood Example with gitk +Additionally when important changes to behaviors, fixes or new feature are introduced an entry must be added to CHANGELOG.md file. Always add new entries at the very top of the file above other existing entries. Use this layout for new entries: + +Area: Details about the change [reference thread / issue] + +When multiple areas are affected list the areas separated with a /: + +Area1/Area2: Detail about the change [reference thread / issue] + +Here is a (non exhaustive) list of Areas that can be used: +* Bluetooth +* Cloud-storage +* Desktop +* Dive pictures +* Import +* Libdivecomputer +* Map-widget +* Mobile +* Planner +* Printing +* Profile + [1]: http://lists.subsurface-divelog.org/cgi-bin/mailman/listinfo/subsurface [2]: http://freenode.net/ [3]: https://www.transifex.com/ @@ -64,6 +85,3 @@ Example with gitk [8]: https://subsurface-divelog.org/building/ [9]: https://gerrit-review.googlesource.com/Documentation/user-signedoffby.html [10]: https://subsurface-divelog.org/wp-content/uploads/2011/10/Screenshot-gitk-subsurface-1.png "Example with gitk" - - - |