weeheavy/pelican-theme
1
0
Fork 0
forked from github/pelican
Code Pull requests Activity
pelican-theme/CONTRIBUTING.rst

40 lines
2.4 KiB
ReStructuredText
Raw Normal View History

Add CONTRIBUTING file; include in contribute.rst GitHub recently added a feature that looks for a CONTRIBUTING file in repo root and displays it whenever a user creates an issue or submits a pull request. I took this opportunity to put some contribution submission guidelines into that file, including it dynamically inside our existing docs/contribute.rst file to eliminate unnecessary redundancy.
2013-04-13 16:55:13 -07:00
Contribution submission guidelines
==================================
Minor improvements to contributing guidelines
2013-04-14 07:57:13 -07:00
* 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.
Add CONTRIBUTING file; include in contribute.rst GitHub recently added a feature that looks for a CONTRIBUTING file in repo root and displays it whenever a user creates an issue or submits a pull request. I took this opportunity to put some contribution submission guidelines into that file, including it dynamically inside our existing docs/contribute.rst file to eliminate unnecessary redundancy.
2013-04-13 16:55:13 -07:00
* `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.**
For example, if you're hacking on a new feature and find a bugfix that
doesn't *require* your new feature, **make a new distinct branch and pull
request** for the bugfix.
* Adhere to PEP8 coding standards whenever possible.
* Check for unnecessary whitespace via ``git diff --check`` before committing.
* **Add docs and tests for your changes**.
Drop python 3.2 support and move to python 3.3. Jinja 2.7 (released 2013-05-20) supports only Python3 >=3.3 so it is time to drop Python 3.2 and move to 3.3
2013-05-26 12:44:32 +02:00
* `Run all the tests`_ **on both Python 2.7 and 3.3** to ensure nothing was
Add CONTRIBUTING file; include in contribute.rst GitHub recently added a feature that looks for a CONTRIBUTING file in repo root and displays it whenever a user creates an issue or submits a pull request. I took this opportunity to put some contribution submission guidelines into that file, including it dynamically inside our existing docs/contribute.rst file to eliminate unnecessary redundancy.
2013-04-13 16:55:13 -07:00
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).
Minor improvements to contributing guidelines
2013-04-14 07:57:13 -07:00
* After the first line of the commit message, add a blank line and then a more
Add CONTRIBUTING file; include in contribute.rst GitHub recently added a feature that looks for a CONTRIBUTING file in repo root and displays it whenever a user creates an issue or submits a pull request. I took this opportunity to put some contribution submission guidelines into that file, including it dynamically inside our existing docs/contribute.rst file to eliminate unnecessary redundancy.
2013-04-13 16:55:13 -07:00
detailed explanation (when relevant).
Minor improvements to contributing guidelines
2013-04-14 07:57:13 -07:00
* 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 <https://github.com/defunkt/hub/#installation>`_ and then run
`hub pull-request <https://github.com/defunkt/hub/#git-pull-request>`_ to
turn your GitHub issue into a pull request containing your code.
Add CONTRIBUTING file; include in contribute.rst GitHub recently added a feature that looks for a CONTRIBUTING file in repo root and displays it whenever a user creates an issue or submits a pull request. I took this opportunity to put some contribution submission guidelines into that file, including it dynamically inside our existing docs/contribute.rst file to eliminate unnecessary redundancy.
2013-04-13 16:55:13 -07:00
Check out our `Git Tips`_ page or ask on the `#pelican IRC channel`_ if you
need assistance or have any questions about these guidelines.
Minor improvements to contributing guidelines
2013-04-14 07:57:13 -07:00
.. _`plugin`: http://docs.getpelican.com/en/latest/plugins.html
Add CONTRIBUTING file; include in contribute.rst GitHub recently added a feature that looks for a CONTRIBUTING file in repo root and displays it whenever a user creates an issue or submits a pull request. I took this opportunity to put some contribution submission guidelines into that file, including it dynamically inside our existing docs/contribute.rst file to eliminate unnecessary redundancy.
2013-04-13 16:55:13 -07:00
.. _`#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
Minor improvements to contributing guidelines
2013-04-14 07:57:13 -07:00
.. _`Run all the tests`: http://docs.getpelican.com/en/latest/contribute.html#running-the-test-suite
Add CONTRIBUTING file; include in contribute.rst GitHub recently added a feature that looks for a CONTRIBUTING file in repo root and displays it whenever a user creates an issue or submits a pull request. I took this opportunity to put some contribution submission guidelines into that file, including it dynamically inside our existing docs/contribute.rst file to eliminate unnecessary redundancy.
2013-04-13 16:55:13 -07:00
.. _`Git Tips`: https://github.com/getpelican/pelican/wiki/Git-Tips
Copy permalink