comparison CONTRIBUTING @ 756:7c7e296f8c1e

Add a file with contribution guidelines.
author Augie Fackler <>
date Sat, 23 Aug 2014 15:02:03 -0400
children b7eaa734e3b6
equal deleted inserted replaced
755:13d42d321c24 756:7c7e296f8c1e
1 The short version:
2 * Patches should have a good summary line for first line of commit message
3 * Patches should be sent to the Google Group[0]
4 even look at those.
5 * Patch needs to do exactly one thing
6 * testsuite passes
8 The longer version:
10 We use a variant of Mercurial's own contribution
11 system. contains
12 their full guidelines. Key differences are (by rule number):
14 1. For hg-git, I'm not rigied about the "topic: a few words" format
15 for the first line, but I do insist on a sensible summary as the
16 first line of your commit
17 2. We don't require use of issueNNN for bug fixes (we have no robot)
18 3. Use the hg-git google group
19 10. We use mostly pep8 style. The current codebase is a mess, but new
20 code should be basically pep8.
22 0: Pull requests are generally not noticed more than once every few
23 months. If you do a pull request, I'm still going to expect you to
24 have a clean history, and to be willing to rework history so it's
25 clean before I push the "merge" button.