diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 310f79b3..41c38cc7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,9 +1,9 @@ Contribution submission guidelines ================================== -* Consider whether your new feature might be better suited as a - :doc:`plugin`. Folks are usually available in the - `#pelican IRC channel`_ to help make that determination. +* Consider whether your new feature might be better suited as a plugin_. Folks + are usually available in the `#pelican IRC channel`_ if help is needed to + make that determination. * `Create a new git branch`_ specific to your change (as opposed to making your commits in the master branch). * **Don't put multiple fixes/features in the same branch / pull request.** @@ -13,25 +13,28 @@ Contribution submission guidelines * Adhere to PEP8 coding standards whenever possible. * Check for unnecessary whitespace via ``git diff --check`` before committing. * **Add docs and tests for your changes**. -* **Run all the tests on both Python 2.7+ and 3.2+** to ensure nothing was +* `Run all the tests`_ **on both Python 2.7+ and 3.2+** to ensure nothing was accidentally broken. * First line of your commit message should start with present-tense verb, be 50 characters or less, and include the relevant issue number(s) if applicable. *Example:* ``Ensure proper PLUGIN_PATH behavior. Refs #428.`` If the commit *completely fixes* an existing bug report, please use ``Fixes #585`` or ``Fix #585`` syntax (so the relevant issue is automatically closed upon PR merge). -* After the first line of the commit message, add two returns and then a more +* After the first line of the commit message, add a blank line and then a more detailed explanation (when relevant). -* **Use** ``hub pull-request`` when submitting code for a **pre-existing GitHub - Issue**. This isn't an absolute requirement, but makes the maintainers' lives - much easier! Specifically: `install hub - `_ and then run `hub - pull-request `_ to turn the - issue into a pull request containing your code. +* If you have previously filed a GitHub issue and want to contribute code that + addresses that issue, **please use** ``hub pull-request`` instead of using + GitHub's web UI to submit the pull request. This isn't an absolute + requirement, but makes the maintainers' lives much easier! Specifically: + `install hub `_ and then run + `hub pull-request `_ to + turn your GitHub issue into a pull request containing your code. Check out our `Git Tips`_ page or ask on the `#pelican IRC channel`_ if you need assistance or have any questions about these guidelines. +.. _`plugin`: http://docs.getpelican.com/en/latest/plugins.html .. _`#pelican IRC channel`: http://webchat.freenode.net/?channels=pelican&uio=d4 .. _`Create a new git branch`: https://github.com/getpelican/pelican/wiki/Git-Tips#making-your-changes +.. _`Run all the tests`: http://docs.getpelican.com/en/latest/contribute.html#running-the-test-suite .. _`Git Tips`: https://github.com/getpelican/pelican/wiki/Git-Tips