diff options
| author | Jon Waltman <jonathan.waltman@gmail.com> | 2012-12-02 01:18:54 -0600 |
|---|---|---|
| committer | Jon Waltman <jonathan.waltman@gmail.com> | 2012-12-02 01:18:54 -0600 |
| commit | fa393fd68a0696a8b19fe634871efab3bfa1b010 (patch) | |
| tree | 85e78caec1b26fc70889da73cd9e656ffe4d5363 /doc/devguide.rst | |
| parent | ec28ac53c3f1fdc7ab949a029331b57f16191f77 (diff) | |
| download | sphinx-fa393fd68a0696a8b19fe634871efab3bfa1b010.tar.gz | |
devguide: Elaborate on pull requests
Diffstat (limited to 'doc/devguide.rst')
| -rw-r--r-- | doc/devguide.rst | 32 |
1 files changed, 21 insertions, 11 deletions
diff --git a/doc/devguide.rst b/doc/devguide.rst index a47d7dfd..e175a6f4 100644 --- a/doc/devguide.rst +++ b/doc/devguide.rst @@ -1,6 +1,5 @@ -************************** - Sphinx Developer's Guide -************************** +Sphinx Developer's Guide +======================== .. topic:: Abstract @@ -18,7 +17,7 @@ The Sphinx source code is managed using `Mercurial`_ and is hosted on sphinx-users <sphinx-users@googlegroups.com> Mailing list for user support. -sphinx-dev <sphinx-dev@googlegroups.com> +sphinx-dev <sphinx-dev@googlegroups.com> Mailing list for development related discussions. #pocoo on irc.freenode.net @@ -53,11 +52,19 @@ and post that instead. Contributing to Sphinx ---------------------- -The recommended way to contribute code to Sphinx is to fork the Mercurial -repository on BitBucket and then submit a pull request after committing your -changes. +The recommended way for new contributors to submit code to Sphinx is to fork +the Mercurial repository on BitBucket and then submit a pull request after +committing the changes. -These are the basic steps needed to start developing. +Developers with write access to the main repository are also encouraged to +create pull requests for non-trivial changes so they may be reviewed before +being committed. + + +Getting Started +~~~~~~~~~~~~~~~ + +These are the basic steps needed to start developing on Sphinx. .. todo:: @@ -132,12 +139,15 @@ These are the basic steps needed to start developing. __ https://confluence.atlassian.com/display/BITBUCKET/Automatically+Resolving+Issues+when+Users+Push+Code -#. Push changes to your forked repo on BitBucket. :: +#. Push changes to your forked repository on BitBucket. :: hg push -#. Submit a pull request from your repo to ``birkenfeld/sphinx`` using the - BitBucket interface. +#. Submit a pull request from your repository to ``birkenfeld/sphinx`` using + the BitBucket interface. + + The pull request will be reviewed and if approved, merged by one of the + Sphinx developers. Coding Guide |