[tor-commits] [sbws/master] Add changelog to docs, add info about it in contributing

[pastly at torproject.org]

commit 4851d077ef66fc78f2e8e77dab2deb7bfb3d5bda
Author: Matt Traudt <sirmatt at ksu.edu>
Date:   Tue Jun 12 21:37:53 2018 -0400

    Add changelog to docs, add info about it in contributing
---
 CONTRIBUTING.rst         | 11 +++++++++++
 docs/source/CHANGELOG.md |  1 +
 docs/source/index.rst    |  1 +
 3 files changed, 13 insertions(+)

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 683b5cb..31d0324 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -52,6 +52,15 @@ approxmiately all sbws configuration options and can be changed with an sbws
 update. The latter is used as a starting point for generating a client's
 ``config.ini`` and changes to it only affect newly generated config files.
 
+**Document your addition, fix, change, or whatever in the changelog**. See
+`keep a changelog`_ for the standard we follow. Of note, add Added, Changed,
+Deprecated, Removed, Fixed, and Security headings as needed in the Unreleased
+section. **If your change has a trac or GitHub ticket, reference it** like
+``(GH#123)`` or ``(trac#22104)``. When it comes time to do a release, the
+person doing the release should (1) change the name of the Unreleased section
+and add a new one, and (2) update the links at the bottom.
+
+
 .. _commit-msg:
 
 Example commit message
@@ -89,3 +98,5 @@ With thanks to `Tim Pope`_:
 .. _pull request: https://github.com/pastly/simple-bw-scanner/compare
 
 .. _tim pope: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+
+.. _`keep a changelog`: https://keepachangelog.com/en/1.0.0/
diff --git a/docs/source/CHANGELOG.md b/docs/source/CHANGELOG.md
new file mode 120000
index 0000000..699cc9e
--- /dev/null
+++ b/docs/source/CHANGELOG.md
@@ -0,0 +1 @@
+../../CHANGELOG.md
\ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
index e1942d0..ec605db 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -18,6 +18,7 @@ Contents
    INSTALL
    DEPLOY
    README
+   CHANGELOG
    CONTRIBUTING
    AUTHORS
    LICENSE