contributing.rst 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. Contributing to nose
  2. ====================
  3. You'd like to contribute to nose? Great! Now that nose is hosted under
  4. `GitHub <http://github.com/>`__, contributing is even easier.
  5. Get the code!
  6. -------------
  7. Start by getting a local working copy of nose from github::
  8. git clone https://github.com/nose-devs/nose
  9. If you plan to submit changes back to the core repository, you should set up a
  10. public fork of your own somewhere (`GitHub <http://github.com/>`__ is a good
  11. place to do that). See GitHub's `help <http://help.github.com/>`__ for details
  12. on how to contribute to a Git hosted project like nose.
  13. Running nose's tests
  14. --------------------
  15. nose runs its own test suite with `tox
  16. <http://codespeak.net/tox/>`. You don't have to install tox to run
  17. nose's test suite, but you should, because tox makes it easy to run
  18. all tests on all supported python versions. You'll also need python
  19. 2.4, 2.5, 2.6, 2.7, 3.1 and jython installed somewhere in your $PATH.
  20. Discuss
  21. -------
  22. Join the `nose developer list
  23. <http://groups.google.com/group/nose-dev>`__ at google groups. It's
  24. low-traffic and mostly signal.
  25. What to work on?
  26. ----------------
  27. You can find a list of open issues at nose's `issue tracker
  28. <http://github.com/nose-devs/nose/issues>`__. If you'd like to
  29. work on an issue, leave a comment on the issue detailing how you plan
  30. to fix it, or simply submit a pull request.
  31. I have a great idea for a plugin...
  32. -----------------------------------
  33. Great! :doc:`Write it <plugins/writing>`. Release it on `pypi
  34. <http://pypi.python.org>`__. If it gains a large following, and
  35. becomes stable enough to work with nose's 6+ month release cycles, it
  36. may be a good candidate for inclusion in nose's builtin plugins.