Commits

Marc Abramowitz committed dfecceb

Take a stab at documenting a bit about how to contribute to coverage.py,
mainly focused on how to run the tests.

  • Participants
  • Parent commits 546e2d6

Comments (0)

Files changed (2)

doc/contributing.rst

+.. _contributing:
+
+==================
+Contributing
+==================
+
+How to check out the code
+-------------------------
+
+Development of coverage.py happens in a `Mercurial
+<http://mercurial.selenic.com/>`_ repository at
+https://bitbucket.org/ned/coveragepy
+
+
+How to run the tests
+--------------------------
+
+First use ``build_ve.sh`` to build a bunch of virtualenvs in ``../ve``
+
+Here's an example of a way to do this on OS X::
+
+    $ ./build_ve.sh /Library/Frameworks/Python.framework/Versions/?.?
+
+Then use ``alltests.sh`` to run the tests for all of the virtualenvs::
+
+    $ ./alltests.sh
+
+We are experimenting currently with using `tox <http://tox.testrun.org/>`_ to
+replace these two scripts as it's easier to use and a fair amount of
+Pythonistas are already familiar with it. You can follow the progress of this
+at
+https://bitbucket.org/ned/coveragepy/pull-request/4/add-support-for-tox-http-toxtestrunorg
     subprocess
     api
     faq
+    contributing
     changes