Skip to content

Latest commit

 

History

History
40 lines (37 loc) · 2.43 KB

CONTRIBUTING.rst

File metadata and controls

40 lines (37 loc) · 2.43 KB
Raw

Contribution submission guidelines

  • 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. 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.
  • 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 a blank line and then a more detailed explanation (when relevant).
  • 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.