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