Skip to content
Browse files

Language changes + addition to guidelines

  • Loading branch information...
1 parent b9ef44e commit ec13bcb4c7c20c6eed327078a3f427f2f3596819 @bitprophet bitprophet committed Feb 27, 2013
Showing with 10 additions and 3 deletions.
  1. +10 −3 CONTRIBUTING.rst
View
13 CONTRIBUTING.rst
@@ -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``.

0 comments on commit ec13bcb

Please sign in to comment.
Something went wrong with that request. Please try again.