sprockets.mixins.metrics/docs/contributing.rst

How to Contribute
=================
Do you want to contribute fixes or improvements?

   **AWesome!** *Thank you very much, and let's get started.*

Set up a development environment
--------------------------------
The first thing that you need is a development environment so that you can
run the test suite, update the documentation, and everything else that is
involved in contributing.  The easiest way to do that is to create a virtual
environment for your endevours::

   $ python3.4 -mvenv env

Don't worry about writing code against previous versions of Python unless
you you don't have a choice.  That is why we run our tests through `tox`_.
If you don't have a choice, then install `virtualenv`_ to create the
environment instead.  The next step is to install the development tools
that this project uses.  These are listed in *requires/development.txt*::

   $ env/bin/pip install -qr requires/development.txt

At this point, you will have everything that you need to develop at your
disposal.  *setup.py* is the swiss-army knife in your development tool
chest.  It provides the following commands:

**./setup.py nosetests**
   Run the test suite using `nose`_ and generate a nice coverage report.

**./setup.py build_sphinx**
   Generate the documentation using `sphinx`_.

**./setup.py flake8**
   Run `flake8`_ over the code and report style violations.

If any of the preceding commands give you problems, then you will have to
fix them **before** your pull request will be accepted.

Running Tests
-------------
The easiest (and quickest) way to run the test suite is to use the
*nosetests* command.  It will run the test suite against the currently
installed python version and report not only the test result but the
test coverage as well::

   $ ./setup.py nosetests
   running nosetests
   running egg_info
   writing sprockets.mixins.metrics.egg-info/PKG-INFO
   writing top-level names to sprockets.mixins.metrics.egg-info/top_level.txt
   writing dependency_links to sprockets.mixins.metrics.egg-info/dependency_links.txt
   writing namespace_packages to sprockets.mixins.metrics.egg-info/namespace_packages.txt
   reading manifest file 'sprockets.mixins.metrics.egg-info/SOURCES.txt'
   reading manifest template 'MANIFEST.in'
   writing manifest file 'sprockets.mixins.metrics.egg-info/SOURCES.txt'
   test_that_cached_socket_is_used (tests.StatsdMethodTimingTests) ... ok
   test_that_counter_accepts_increment_value (tests.StatsdMethodTimingTests) ... ok
   test_that_counter_increment_defaults_to_one (tests.StatsdMethodTimingTests) ... ok
   test_that_default_prefix_is_stored (tests.StatsdMethodTimingTests) ... ok
   test_that_execution_timer_records_time_spent (tests.StatsdMethodTimingTests) ... ok
   test_that_http_method_call_is_recorded (tests.StatsdMethodTimingTests) ... ok
   
   ----------------------------------------------------------------------
   Ran 6 tests in 1.080s
   
   OK

That's the quick way to run tests.  The slightly longer way is to run
the `tox`_ utility.  It will run the test suite against all of the supported
python versions in parallel.  This is essentially what Travis-CI
will do when you issue a pull request anyway::

   $ env/bin/tox
   GLOB sdist-make: /Users/daves/Source/platform/sprockets.mixins.metrics/setup.py
   py27 create: /Users/daves/Source/platform/sprockets.mixins.metrics/build/tox/py27
   py27 installdeps: -rrequires/testing.txt
   
   ------------------------- >8 ------------------------------------------------------
   
     py27: commands succeeded
     py34: commands succeeded
     py35: commands succeeded
   SKIPPED:  pypy: InterpreterNotFound: pypy
     congratulations :)

This is what you want to see.  Now you can make your modifications and keep
the tests passing.  If you see the "missing interpreter" errors, that means
that you do not have all of the interpreters installed.

Submitting a Pull Request
-------------------------
Once you have made your modifications, gotten all of the tests to pass,
and added any necessary documentation, it is time to contribute back for
posterity.  You've probably already cloned this repository and created a
new branch.  If you haven't, then checkout what you have as a branch and
roll back *master* to where you found it.  Then push your repository up
to github and issue a pull request.  Describe your changes in the request,
if Travis isn't too annoyed someone will review it, and eventually merge
it back.

.. _flake8: http://flake8.readthedocs.org/
.. _nose: http://nose.readthedocs.org/
.. _sphinx: http://sphinx-doc.org/
.. _tox: http://testrun.org/tox/
.. _virtualenv: http://virtualenv.pypa.io/