|
| 1 | +============================== |
| 2 | + Contributing to PRoot / CARE |
| 3 | +============================== |
| 4 | + |
| 5 | +----------------------------------------------------------- |
| 6 | +An introduction to contributing to PRoot / CARE development |
| 7 | +----------------------------------------------------------- |
| 8 | + |
| 9 | +The PRoot Team welcomes, and depends, on contributions from students and |
| 10 | +collaborators in the open source and academic communities. |
| 11 | +Contributions can be made in a number of ways, a few examples are: |
| 12 | + |
| 13 | +- Code patches via pull requests |
| 14 | +- Documentation improvements |
| 15 | +- Bug reports and patch reviews |
| 16 | + |
| 17 | +Reporting an Issue |
| 18 | +================== |
| 19 | + |
| 20 | +Please include as much detail as you can. Let us know your host kernel |
| 21 | +version, e.g, :code:`uname -a`, host/guest distribution, e.g. :code:`cat /etc/os-release`, |
| 22 | +and the :code:`PRoot`/:code:`CARE` version number. If you get an error please include the full |
| 23 | +error and/or traceback. Issues are tracked on GitHub at <https://github.com/proot-me/proot/issues>, |
| 24 | +or can also be sent via the ` mailing list < mailto:[email protected]>`_. |
| 25 | + |
| 26 | +Submitting Pull Requests |
| 27 | +======================== |
| 28 | + |
| 29 | +Once you are happy with your changes or you are ready for some feedback, push |
| 30 | +it to your fork and send a pull request. For a change to be accepted it will |
| 31 | +most likely need to have updated tests and/or documentation. New features |
| 32 | +**require** additional tests in order to be included in a future release. |
| 33 | + |
| 34 | +Resources |
| 35 | +========= |
| 36 | + |
| 37 | +- `Contributing to Open Source Projects <http://www.contribution-guide.org>`_ |
| 38 | + |
| 39 | +- `How To Ask Questions The Smart Way <http://www.catb.org/esr/faqs/smart-questions.html>`_ |
| 40 | + |
| 41 | +- `Indentation Style - Wikipedia <https://en.wikipedia.org/wiki/Indentation_style#K&R_style>`_ |
0 commit comments