EbookFoundation
/
readthedocs.org
mirror of https://github.com/EbookFoundation/readthedocs.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

More friendly guide about what to development can be contributed

build-pdf-ret-val
Gregor Müllegger 2015-07-21 10:39:31 +02:00
parent c4dc109846
commit 5852d65df2
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/contribute.rst
View File

@ -14,26 +14,28 @@ get stuck at any point, feel free to get in touch in our IRC channel
Contributing to development Contributing to development
--------------------------- ---------------------------
Read the Docs follows the standard Contribution Guidelines set forth at If you want to deep dive and help out with development on Read the Docs, then
`contribution-guide.org`_. Please read that site and follow the instructions first get the project installed locally according to the
to make sure your patches will be accepted. :ref:`Installation Guide <installing-read-the-docs>`. After that is done we
suggest you have a look at tickets in our issue tracker that are labelled `Good
First Bug`_. These are a meant to be a great way to get a smooth start and
won't put you in front of the most complex parts of the system.
.. _contribution-guide.org: http://www.contribution-guide.org/#submitting-bugs If you are up to more challenging tasks with a bigger scope, then 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. If
you still didn't find something to work on, search for the `Sprintable`_
label. Those tickets are meant to be standalone and can be worked on ad-hoc.
Tickets When contributing code, then please follow the standard Contribution
------- Guidelines set forth at `contribution-guide.org`_.
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 .. _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 .. _Good First Bug: https://github.com/rtfd/readthedocs.org/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Bug%22
.. _Sprintable: https://github.com/rtfd/readthedocs.org/issues?q=is%3Aopen+is%3Aissue+label%3ASprintable
.. _contribution-guide.org: http://www.contribution-guide.org/#submitting-bugs
Translations Translations
------------ ------------