github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Minor improvements to contributing guidelines

Browse source
This commit is contained in:
Justin Mayer 2013-04-14 07:57:13 -07:00
commit a2a3f5a393
1 changed files with 14 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

25
CONTRIBUTING.rst
View file

@ -1,9 +1,9 @@
Contribution submission guidelines Contribution submission guidelines
================================== ==================================
* Consider whether your new feature might be better suited as a * Consider whether your new feature might be better suited as a plugin_. Folks
:doc:`plugin<plugins>`. Folks are usually available in the are usually available in the `#pelican IRC channel`_ if help is needed to
`#pelican IRC channel`_ to help make that determination. make that determination.
* `Create a new git branch`_ specific to your change (as opposed to making * `Create a new git branch`_ specific to your change (as opposed to making
your commits in the master branch). your commits in the master branch).
* **Don't put multiple fixes/features in the same branch / pull request.** * **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. * Adhere to PEP8 coding standards whenever possible.
* Check for unnecessary whitespace via ``git diff --check`` before committing. * Check for unnecessary whitespace via ``git diff --check`` before committing.
* **Add docs and tests for your changes**. * **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. accidentally broken.
* First line of your commit message should start with present-tense verb, be 50 * 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. characters or less, and include the relevant issue number(s) if applicable.
*Example:* ``Ensure proper PLUGIN_PATH behavior. Refs #428.`` If the commit *Example:* ``Ensure proper PLUGIN_PATH behavior. Refs #428.`` If the commit
*completely fixes* an existing bug report, please use ``Fixes #585`` or ``Fix *completely fixes* an existing bug report, please use ``Fixes #585`` or ``Fix
#585`` syntax (so the relevant issue is automatically closed upon PR merge). #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). detailed explanation (when relevant).
* **Use** ``hub pull-request`` when submitting code for a **pre-existing GitHub * If you have previously filed a GitHub issue and want to contribute code that
Issue**. This isn't an absolute requirement, but makes the maintainers' lives addresses that issue, **please use** ``hub pull-request`` instead of using
much easier! Specifically: `install hub GitHub's web UI to submit the pull request. This isn't an absolute
<https://github.com/defunkt/hub/#installation>`_ and then run `hub requirement, but makes the maintainers' lives much easier! Specifically:
pull-request <https://github.com/defunkt/hub/#git-pull-request>`_ to turn the `install hub <https://github.com/defunkt/hub/#installation>`_ and then run
issue into a pull request containing your code. `hub pull-request <https://github.com/defunkt/hub/#git-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 Check out our `Git Tips`_ page or ask on the `#pelican IRC channel`_ if you
need assistance or have any questions about these guidelines. 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 .. _`#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 .. _`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 .. _`Git Tips`: https://github.com/getpelican/pelican/wiki/Git-Tips