/docs/source/develop/contribute.rst

https://github.com/thorrak/fermentrack · ReStructuredText · 41 lines · 26 code · 15 blank · 0 comment · 0 complexity · 40734a7cc6b76fedebcb5d105245921c MD5 · raw file 

    

  1. .. include:: ../global.rst
    2. 

  2. 

  3. Contributing to Fermentrack
    4. 

  4. ==============================
    5. 

  5. 

  6. Want to help? Great! There are a number of ways you can get involved in this project. To help you get started, some
    7. 

  7. areas in which you can contribute are listed below along with additional resources for getting started.
    8. 

  8. 

  9. 

  10. Reporting Bugs/Issues
    11. 

  11. ----------------------
    12. 

  12. 

  13. Found a bug or issue (or have a suggestion for how to improve)? Awesome!
    14. 

  14. 

  15. The best way to reach out is to either open an issue on GitHub_ or discuss your issue or idea in the
    16. 

  16. HomeBrewTalk thread (or - ideally - both). Both of these are actively monitored, and will help to keep track of progress
    17. 

  17. towards a resolution.
    18. 

  18. 

  19. 

  20. Developing Fermentrack
    21. 

  21. -----------------------
    22. 

  22. 

  23. Interested in helping develop Fermentrack (or improving its look & feel)? Fantastic - Fermentrack is an open source
    24. 

  24. project, and all help is welcome.
    25. 

  25. 

  26. Fermentrack is a Python-based application which uses the Django framework. It is open source and is managed on GitHub.
    27. 

  27. To help you get started, take a look at the developer documentation located within :doc:`/develop/index`. After reading,
    28. 

  28. if you have questions don't hesitate to reach out. I do recommend reaching out (either on HomeBrewTalk or by raising an
    29. 

  29. issue on GitHub) prior to developing a feature that you ultimately would like merged back in.
    30. 

  30. 

  31. 

  32. Documenting Fermentrack
    33. 

  33. -------------------------------------
    34. 

  34. 

  35. A project like Fermentrack is only as good as its documentation. Documentation for Fermentrack is (currently) written in
    36. 

  36. `reStructuredText <http://docutils.sourceforge.net/rst.html>`__ with an eye towards `Sphinx <http://www.sphinx-doc.org/en/stable/>`__.
    37. 

  37. The source for the documentation is located in the ``docs/source`` folder in the Fermentrack repo on GitHub_.
    38. 

  38. 

  39. If you are familiar with GitHub, pull requests that include documentation fixes are always welcome. If not, reach out on
    40. 

  40. GitHub or the HomeBrewTalk forums and we'll be happy to help get things updated.
    41.