From 3de2feca1d4c4e95b05f2ecef6e803c8a872fd4e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gon=C3=A7alo=20Val=C3=A9rio?= <gon@ovalerio.net>
Date: Mon, 6 Jan 2020 12:06:15 +0000
Subject: [PATCH] Update contribution instructions

---
 CONTRIBUTING.rst | 29 ++++++++++++++++-------------
 HISTORY.rst      |  5 +++--
 2 files changed, 19 insertions(+), 15 deletions(-)

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index c90466c..be7de5d 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -3,7 +3,7 @@ Contributing
 ============
 
 Contributions are welcome, and they are greatly appreciated! Every
-little bit helps, and credit will always be given. 
+little bit helps, and credit will always be given.
 
 You can contribute in many ways:
 
@@ -36,7 +36,7 @@ is open to whoever wants to implement it.
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-Django-Cryptolock could always use more documentation, whether as part of the 
+Django-Cryptolock could always use more documentation, whether as part of the
 official Django-Cryptolock docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
@@ -66,7 +66,7 @@ Ready to contribute? Here's how to set up `django-cryptolock` for local developm
 
     $ mkvirtualenv django-cryptolock
     $ cd django-cryptolock/
-    $ python setup.py develop
+    $ pip install -r requirements_dev.txt -r requirements_test.txt
 
 4. Create a branch for local development::
 
@@ -74,22 +74,25 @@ Ready to contribute? Here's how to set up `django-cryptolock` for local developm
 
    Now you can make your changes locally.
 
-5. When you're done making changes, check that your changes pass flake8 and the
-   tests, including testing other Python versions with tox::
+5. When you're done making changes, check that your changes pass ``black`` and the
+   tests, including testing other Python versions with ``tox``:
 
-        $ flake8 django_cryptolock tests
-        $ python setup.py test
-        $ tox
+        $ black --check django_cryptolock
+        $ make test
+        $ make test-all
 
-   To get flake8 and tox, just pip install them into your virtualenv. 
+   To get black and tox, just pip install them into your virtualenv.
 
-6. Commit your changes and push your branch to GitHub::
+6. If your changes are visible to the user, you can add a demo for them to the
+   example project.
+
+7. Commit your changes and push your branch to GitHub::
 
     $ git add .
     $ git commit -m "Your detailed description of your changes."
     $ git push origin name-of-your-bugfix-or-feature
 
-7. Submit a pull request through the GitHub website.
+8. Submit a pull request through the GitHub website.
 
 Pull Request Guidelines
 -----------------------
@@ -100,7 +103,7 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
-3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check 
+3. The pull request should work for Python 3.6, 3.7 and 3.8. Check
    https://travis-ci.org/dethos/django-cryptolock/pull_requests
    and make sure that the tests pass for all supported Python versions.
 
@@ -109,4 +112,4 @@ Tips
 
 To run a subset of tests::
 
-    $ python -m unittest tests.test_django_cryptolock
+    $ pytest tests/test_models.py
diff --git a/HISTORY.rst b/HISTORY.rst
index 5aab992..b6b431a 100644
--- a/HISTORY.rst
+++ b/HISTORY.rst
@@ -3,12 +3,13 @@
 History
 -------
 
-0.0.2 (2019-??-??)
+0.0.2 (2020-??-??)
 ++++++++++++++++++
 
-* A default urls.py is provided by the package so can work "out-of-the-box".
+* A default ``urls.py`` is provided by the package so can work "out-of-the-box".
 * Default location for templates moved to ``django_cryptolock`` folder.
 * Update quickstart guide.
+* Update instructions to contribute to the project.
 
 0.0.1 (2019-11-25)
 ++++++++++++++++++