CONTRIBUTING.rst 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. ============
  2. Contributing
  3. ============
  4. Contributions are welcome, and they are greatly appreciated! Every
  5. little bit helps, and credit will always be given.
  6. You can contribute in many ways:
  7. Types of Contributions
  8. ----------------------
  9. Report Bugs
  10. ~~~~~~~~~~~
  11. Report bugs at https://github.com/django-nose/django-nose/issues.
  12. If you are reporting a bug, please include:
  13. * The version of django, nose, and django-nose you are using, and any other
  14. applicable packages (``pip freeze`` will show current versions)
  15. * Any details about your local setup that might be helpful in troubleshooting.
  16. * Detailed steps to reproduce the bug.
  17. When someone submits a pull request to fix your bug, please try it out and
  18. report if it worked for you.
  19. Fix Bugs
  20. ~~~~~~~~
  21. Look through the GitHub issues for bugs. Anything untagged or tagged with "bug"
  22. is open to whoever wants to implement it.
  23. Implement Features
  24. ~~~~~~~~~~~~~~~~~~
  25. Look through the GitHub issues for features. Anything untagged ot tagged with
  26. "feature" is open to whoever wants to implement it.
  27. django-nose is built on nose, which supports plugins. Consider implementing
  28. your feature as a plugin, maintained by the community using that feature,
  29. rather than adding to the django-nose codebase.
  30. Write Documentation
  31. ~~~~~~~~~~~~~~~~~~~
  32. django-nose could always use more documentation, whether as part of the
  33. official django-nose, as code comments, or even on the web in blog posts,
  34. articles, and such.
  35. Submit Feedback
  36. ~~~~~~~~~~~~~~~
  37. The best way to send feedback is to file an issue at
  38. https://github.com/django-nose/django-nose/issues.
  39. If you are proposing a feature:
  40. * Explain in detail how it would work.
  41. * Keep the scope as narrow as possible, to make it easier to implement.
  42. * Remember that this is a volunteer-driven project, and that contributions
  43. are welcome :)
  44. Get Started!
  45. ------------
  46. Ready to contribute? Here's how to set up django-nose
  47. for local development.
  48. 1. Fork the `django-nose` repo on GitHub.
  49. 2. Clone your fork locally::
  50. $ git clone git@github.com:your_name_here/django-nose.git
  51. 3. Install your local copy into a virtualenv. Assuming you have
  52. virtualenvwrapper installed, this is how you set up your fork for local
  53. development::
  54. $ mkvirtualenv django-nose
  55. $ cd django-nose/
  56. $ pip install -r requirements.txt
  57. $ ./manage.py migrate
  58. 4. Create a branch for local development::
  59. $ git checkout -b name-of-your-bugfix-or-feature
  60. Now you can make your changes locally.
  61. 5. Make sure existing tests continue to pass with your new code::
  62. $ make qa
  63. 6. When you're done making changes, check that your changes pass flake8 and the
  64. tests, including testing other Python versions with tox::
  65. $ make qa-all
  66. 6. Commit your changes and push your branch to GitHub::
  67. $ git add .
  68. $ git commit -m "Your detailed description of your changes."
  69. $ git push origin name-of-your-bugfix-or-feature
  70. 7. Submit a pull request through the GitHub website.
  71. Pull Request Guidelines
  72. -----------------------
  73. Before you submit a pull request, check that it meets these guidelines:
  74. 1. The pull request should be in a branch.
  75. 2. The pull request should include tests.
  76. 3. You agree to license your contribution under the BSD license.
  77. 4. If the pull request adds functionality, the docs should be updated.
  78. 5. Make liberal use of `git rebase` to ensure clean commits on top of master.
  79. 6. The pull request should pass QA tests and work for supported Python / Django
  80. combinations. Check
  81. https://travis-ci.org/django-nose/django-nose/pull_requests
  82. and make sure that the tests pass for all supported Python versions.
  83. Tips
  84. ----
  85. The django-nose testapp uses django-nose, so all of the features are available.
  86. To run a subset of tests::
  87. $ ./manage.py test testapp/tests.py
  88. To mark failed tests::
  89. $ ./manage.py test --failed
  90. To re-run only the failed tests::
  91. $ ./manage.py test --failed