Skip to content

Commit

Permalink
Language changes + addition to guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
bitprophet committed Feb 27, 2013
1 parent b9ef44e commit ec13bcb
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,16 @@ Patch submission guidelines

This makes life much easier for maintainers if you have (or ever plan to
have) additional changes in your own ``master`` branch.
* Base **bugfixes** off the **latest release branch** (e.g. ``1.4``) and **new
features** off of **master**. If you're unsure which category your change
falls in, just ask on IRC or the mailing list -- it's often a judgement call.

* A corollary: please **don't put multiple fixes/features in the same
branch/pull request**! In other words, if you're hacking on new feature X
and find a bugfix that doesn't *require* new feature X, **make a new
distinct branch and PR** for the bugfix.

* Base **bugfixes** off the **latest release branch** (e.g. ``1.4``, ``1.5`` or
whatever's newest) and **new features** off of **master**. If you're unsure
which category your change falls in, just ask on IRC or the mailing list --
it's often a judgement call.
* **Make sure documentation is updated** -- at the very least, keep docstrings
current, and if necessary, update the ReST documentation in ``docs/``. For
example, new ``env.*`` settings should be added to ``docs/usage/env.rst``.
Expand Down

0 comments on commit ec13bcb

Please sign in to comment.