diff options
| author | Takayuki Shimizukawa <shimizukawa@gmail.com> | 2014-08-30 19:02:01 +0400 |
|---|---|---|
| committer | Takayuki Shimizukawa <shimizukawa@gmail.com> | 2014-08-30 19:02:01 +0400 |
| commit | 0cfb00db79901c3c018a5966e9671ea58eb7765c (patch) | |
| tree | 998c082bec05fe6778ce2bf3ca0b87bfd6a494c3 /README.rst | |
| parent | 9acf2527ce4ff85ebbbb74c0b06ab4836da6e9d7 (diff) | |
Add documentation to make contribution easier.
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/README.rst b/README.rst index 5963a0ae8..4b072655e 100644 --- a/README.rst +++ b/README.rst @@ -39,4 +39,20 @@ If you want to use a different interpreter, e.g. ``python3``, use:: Contributing ============ -Send wishes, comments, patches, etc. to sphinx-dev@googlegroups.com. +#. Check for open issues or open a fresh issue to start a discussion around a + feature idea or a bug. There are `Non Assigned`_ issues. +#. If you feel uncomfortable or uncertain about an issue or your changes, feel + free to email sphinx-dev@googlegroups.com. +#. Fork `the repository`_ on Bitbucket to start making your changes to the + **default** branch for next major version, or **stable** branch for next + minor version. +#. Write a test which shows that the bug was fixed or that the feature works + as expected. +#. Send a pull request and bug the maintainer until it gets merged and + published. :) Make sure to add yourself to AUTHORS_ and the change to + CHANGES_. + +.. _`the repository`: https://bitbucket.org/birkenfeld/sphinx +.. _AUTHORS: https://bitbucket.org/birkenfeld/sphinx/src/tip/AUTHORS +.. _CHANGES: https://bitbucket.org/birkenfeld/sphinx/src/tip/CHANGES +.. _Non Assigned: https://bitbucket.org/birkenfeld/sphinx/issues?status=new&status=open&responsible= |