Merge pull request #71 from pastly/issue54

First draft of CONTRIBUTING.rst

CONTRIBUTING.rst

+Contributing to Simple Bandwidth Scanner
+----------------------------------------
+
+Thank you for your interest in Simple Bandwidth Scanner (sbws).
+
+.. note::
+
+    Simple Bandwidth Scanner is in the public domain according to its
+    :doc:`CC0 license </LICENSE>`. No one has copyright over sbws, though we
+    update the list of :doc:`authors </AUTHORS>` from time to time.
+
+
+Pull requests are welcome, especially if they address open issues.
+
+#. Fork the repo on GitHub
+#. Clone a copy of sbws to your machine as per
+   :doc:`the install instructions </INSTALL>`, but use your repo.
+#. Fix that bug or implement that feature
+    - As part of this process, it would be appreciated (and might event help
+      you) if you wrote tests to catch the buggy behavior you're solving so it
+      won't break again.
+#. Make sure all tests pass when running ``tox``.
+#. Commit your changes and push them to a branch in your sbws GitHub repo
+#. Open a `pull request`_
+
+We use flake8 to enforce standard python coding style. This will be checked
+with ``tox``.
+
+**Write good commit messages** that at least follow the spirit of
+:ref:`this example <commit-msg>`.
+
+**Write many small commits** each containing an atomic change instead of one
+large mega-commit. This not only makes code review easier, but it also makes
+commits that show up in ``git blame`` 10 years from now make more sense.
+
+Simple Bandwidth Scanner is moving towards 100% test coverage. Please help us
+reach that goal, or at least not move us away from it.
+
+.. _commit-msg:
+
+Example commit message
+======================
+
+With thanks to `Tim Pope`_:
+
+
+::
+
+    Capitalized, short (50 chars or less) summary
+
+    More detailed explanatory text, if necessary.  Wrap it to about 72
+    characters or so.  In some contexts, the first line is treated as the
+    subject of an email and the rest of the text as the body.  The blank
+    line separating the summary from the body is critical (unless you omit
+    the body entirely); tools like rebase can get confused if you run the
+    two together.
+
+    Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
+    or "Fixes bug."  This convention matches up with commit messages generated
+    by commands like git merge and git revert.
+
+    Further paragraphs come after blank lines.
+
+    - Bullet points are okay, too
+
+    - Typically a hyphen or asterisk is used for the bullet, followed by a
+      single space, with blank lines in between, but conventions vary here
+
+    - Use a hanging indent
+
+
+
+.. _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

INSTALL.rst

+.. _install:
+
 Installing Simple Bandwidth Scanner
 -----------------------------------
 
@@ -7,8 +9,10 @@ First, clone the repo. Then
 
     virtualenv -p python3 venv
     source venv/bin/activate
-    pip install .
+    pip install .  # if this is for deployment
+    pip install -e .[test]  # if this is for development or testing
     sbws init
     sbws client -h
     sbws server -h
 
+Make sure the sbws commands complete without error.

docs/source/CONTRIBUTING.rst

+../../CONTRIBUTING.rst
\ No newline at end of file

docs/source/LICENSE.md

+../../LICENSE.md
\ No newline at end of file

docs/source/index.rst

@@ -15,7 +15,9 @@ Welcome to Simple Bandwidth Scanner's documentation!
    INSTALL
    DEPLOY
    README
+   CONTRIBUTING
    AUTHORS
+   LICENSE
    sbws
 
 Indices and tables