Skip to content

Commit

Permalink
Add CONTRIBUTING document
Browse files Browse the repository at this point in the history
  • Loading branch information
steve authored and Steve Lamb committed Jan 22, 2016
1 parent 9ffb68d commit 70af693
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
contributing
------------

in order for a pull request to be merged, please make sure it meets the following criteria:

1. all unit tests pass for all supported versions of python and django.
2. every newly added line of code is exercised by at least one unit test.
3. all code is compliant with PEP8 style conventions.


development setup
-----------------
to setup a development environment, run the following commands::

$ pip install -r dev_requirements.txt


unit testing
------------

to run the unit tests, run the following commands::

$ cd test_app
$ python manage.py test


demo testing
------------

to ensure the app behaves as expected, run the following::

$ cd test_app
$ python manage.py runserver

then, visit ``http://localhost:8000/`` in your browser and confirm it produces a valid CSV.



6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,9 @@ views.py::
return render_to_csv_response(people, delimiter='|')

For more details on possible arguments, see the documentation on `DictWriter <https://docs.python.org/2/library/csv.html#csv.DictWriter>`_.


development and contributions
-----------------------------

Please read the included ``CONTRIBUTING.rst`` file.

0 comments on commit 70af693

Please sign in to comment.