Mercurial > hg-git

annotate CONTRIBUTING @ 1108:aae2d15de6af

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
git_handler: store gpgsig header to maintain commit coherence
author Tony Tung <ttung@chanzuckerberg.com <mailto:ttung@chanzuckerberg.com>>
date Tue, 06 Feb 2018 17:04:24 -0800
parents 06d523eb596a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
755
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 * Patch needs to do exactly one thing
7c7e296f8c1e Add a file with contribution guidelines.
Augie Fackler <raf@durin42.com>
parents:
diff changeset
5 * testsuite passes
7c7e296f8c1e Add a file with contribution guidelines.
Augie Fackler <raf@durin42.com>
parents:
diff changeset
6
7c7e296f8c1e Add a file with contribution guidelines.
Augie Fackler <raf@durin42.com>
parents:
diff changeset
7 The longer version:
7c7e296f8c1e Add a file with contribution guidelines.
Augie Fackler <raf@durin42.com>
parents:
diff changeset
8
7c7e296f8c1e Add a file with contribution guidelines.
Augie Fackler <raf@durin42.com>
parents:
diff changeset
9 We use a variant of Mercurial's own contribution
990
66336cb849b4 CONTRIBUTING: update the link to Mercurial wiki
Anton Shestakov <av6@dwimlabs.net>
parents: 833
diff changeset
10 system. https://www.mercurial-scm.org/wiki/ContributingChanges contains
755
7c7e296f8c1e Add a file with contribution guidelines.
Augie Fackler <raf@durin42.com>
parents:
diff changeset
11 their full guidelines. Key differences are (by rule number):
7c7e296f8c1e Add a file with contribution guidelines.
Augie Fackler <raf@durin42.com>
parents:
diff changeset
12
833
427f26764fab CONTRIBUTING: fix a typo I just noticed
Augie Fackler <raf@durin42.com>
parents: 776
diff changeset
13 1. For hg-git, I'm not strict about the "topic: a few words" format
755
7c7e296f8c1e Add a file with contribution guidelines.
Augie Fackler <raf@durin42.com>
parents:
diff changeset
14 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
15 first line of your commit
7c7e296f8c1e Add a file with contribution guidelines.
Augie Fackler <raf@durin42.com>
parents:
diff changeset
16 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
17 3. Use the hg-git google group
7c7e296f8c1e Add a file with contribution guidelines.
Augie Fackler <raf@durin42.com>
parents:
diff changeset
18 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
19 code should be basically pep8.
7c7e296f8c1e Add a file with contribution guidelines.
Augie Fackler <raf@durin42.com>
parents:
diff changeset
20
1003
06d523eb596a CONTRIBUTING: add more information on the google group
Henning Schild <henning@hennsch.de>
parents: 990
diff changeset
21 0:
06d523eb596a CONTRIBUTING: add more information on the google group
Henning Schild <henning@hennsch.de>
parents: 990
diff changeset
22 Mailing list: hg-git@googlegroups.com
06d523eb596a CONTRIBUTING: add more information on the google group
Henning Schild <henning@hennsch.de>
parents: 990
diff changeset
23 Archives: https://groups.google.com/forum/#!forum/hg-git
06d523eb596a CONTRIBUTING: add more information on the google group
Henning Schild <henning@hennsch.de>
parents: 990
diff changeset
24
06d523eb596a CONTRIBUTING: add more information on the google group
Henning Schild <henning@hennsch.de>
parents: 990
diff changeset
25 Pull requests are generally not noticed more than once every few
755
7c7e296f8c1e Add a file with contribution guidelines.
Augie Fackler <raf@durin42.com>
parents:
diff changeset
26 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
27 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
28 clean before I push the "merge" button.