CONTRIBUTING.rst 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  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. Bug reports
  7. ===========
  8. When `reporting a bug <https://github.com/ionelmc/sphinx-py3doc-enhanced-theme/issues>`_ please include:
  9. * Your operating system name and version.
  10. * Any details about your local setup that might be helpful in troubleshooting.
  11. * Detailed steps to reproduce the bug.
  12. Documentation improvements
  13. ==========================
  14. Enhanced Sphinx theme (based on Python 3 docs) could always use more documentation, whether as part of the
  15. official Enhanced Sphinx theme (based on Python 3 docs) docs, in docstrings, or even on the web in blog posts,
  16. articles, and such.
  17. Feature requests and feedback
  18. =============================
  19. The best way to send feedback is to file an issue at https://github.com/ionelmc/sphinx-py3doc-enhanced-theme/issues.
  20. If you are proposing a feature:
  21. * Explain in detail how it would work.
  22. * Keep the scope as narrow as possible, to make it easier to implement.
  23. * Remember that this is a volunteer-driven project, and that contributions are welcome :)
  24. Development
  25. ===========
  26. To set up `sphinx-py3doc-enhanced-theme` for local development:
  27. 1. `Fork sphinx-py3doc-enhanced-theme on GitHub <https://github.com/ionelmc/sphinx-py3doc-enhanced-theme/fork>`_.
  28. 2. Clone your fork locally::
  29. git clone git@github.com:your_name_here/sphinx-py3doc-enhanced-theme.git
  30. 3. Create a branch for local development::
  31. git checkout -b name-of-your-bugfix-or-feature
  32. Now you can make your changes locally.
  33. 4. When you're done making changes, run all the checks, doc builder and spell checker with `tox <http://tox.readthedocs.org/en/latest/install.html>`_ one command::
  34. tox
  35. 5. Commit your changes and push your branch to GitHub::
  36. git add .
  37. git commit -m "Your detailed description of your changes."
  38. git push origin name-of-your-bugfix-or-feature
  39. 6. Submit a pull request through the GitHub website.
  40. Pull Request Guidelines
  41. -----------------------
  42. If you need some code review or feedback while you're developing the code just make the pull request.
  43. For merging, you should:
  44. 1. Include passing tests (run ``tox``) [1]_.
  45. 2. Update documentation when there's new API, functionality etc.
  46. 3. Add a note to ``CHANGELOG.rst`` about the changes.
  47. 4. Add yourself to ``AUTHORS.rst``.
  48. .. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
  49. `run the tests <https://travis-ci.org/ionelmc/sphinx-py3doc-enhanced-theme/pull_requests>`_ for each change you add in the pull request.
  50. It will be slower though ...
  51. Tips
  52. ----
  53. To run a subset of tests::
  54. tox -e envname -- py.test -k test_myfeature
  55. To run all the test environments in *parallel* (you need to ``pip install detox``)::
  56. detox