[tor-commits] [sbws/master] Merge remote-tracking branch 'gitlab/merge-requests/17' into maint-1.1

[juga at torproject.org]

commit b9f92100102cdffb0c4ee289a6b40efb808c20fd
Merge: 9ecff4e 3fa7af0
Author: Georg Koppen <gk at torproject.org>
Date:   Sun Aug 9 18:14:02 2020 +0000

    Merge remote-tracking branch 'gitlab/merge-requests/17' into maint-1.1

 AUTHORS.md                          |  7 +++-
 DEPLOY.rst                          | 14 +++----
 INSTALL.rst                         |  2 +-
 README.md                           | 14 +++----
 docs/source/contributing.rst        | 73 ++++++++++++++++++++++---------------
 docs/source/man_sbws.ini.rst        |  2 +-
 docs/source/man_sbws.rst            |  2 +-
 docs/source/tor_bandwidth_files.rst |  4 +-
 sbws/core/scanner.py                |  4 +-
 sbws/lib/v3bwfile.py                |  2 +-
 10 files changed, 71 insertions(+), 53 deletions(-)

diff --cc docs/source/contributing.rst
index fb313cc,b5259c8..0d41689
--- a/docs/source/contributing.rst
+++ b/docs/source/contributing.rst
@@@ -133,21 -145,8 +145,21 @@@ but not all
  Commits
  ~~~~~~~~~
  
- Each commit should reference the Tor Project Trac ticket (example: ``#12345``)
+ Each commit should reference the Tor Project Gitlab issue (example: ``#12345``)
  and possibly the bugfix version.
 +The commit message should contain ``Closes: #bugnumber``.
 +
 +From version 1.0.2 we started to prefix the summary with the subpackage or
 +component, though we have not standarized the words to use, eg: ``scanner``,
 +``generate``, ``v3bwfile``, ``relaylist``, ``doc``, ``test``, ``CI``.
 +
 +From version 1.0.3, we also started to prefix the summary with ``new``,
 +``fix`` or ``chg``, so that `gitchangelog`_ automatically generates different
 +sections in the CHANGELOG.
 +
 +From version 1.1.0 we started to use the words ``new``, ``chg`` and ``fix``,
 +not in the sense `gitchangelog`_ use them, but to match sematic versioning
 +changes major, minor and patch.
  
  Try to make each commit a logically separate changes.::