readthedocs.org/docs/contribute.rst

36 lines
1.3 KiB
ReStructuredText

.. _contributing-to-read-the-docs:
Contributing to Read the Docs
=============================
Read the Docs follows the standard Contribution Guidelines set forth at `contribution-guide.org`_.
Please read that site and follow the instructions to make sure your patches will be accepted.
.. _contribution-guide.org: http://www.contribution-guide.org/#submitting-bugs
Tickets
-------
If you are just getting started with the project,
we have tickets labeled `Good First Bug`_.
This is a great way to get started.
If you want to help with a bigger feature,
there are a set of tickets with a `Feature Overview`_ tag.
These tickets have a general overview and description of the work required to finish.
If you want to start somewhere,
this would be a good place to start.
That said,
these aren't necessarily the easiest tickets.
They are simply things that are explained.
.. _Feature Overview: https://github.com/rtfd/readthedocs.org/issues?direction=desc&labels=Feature+Overview&page=1&sort=updated&state=open
.. _Good First Bug: https://github.com/rtfd/readthedocs.org/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Bug%22
Translations
------------
If you wish to contribute translations, please do so on `Transifex`_.
.. _Transifex: https://www.transifex.com/projects/p/readthedocs/