What's cooking (2019/06 #05)
[git.git] / MaintNotes
blobb7fa21f5cce7d046d3a449354a87688c7bce79e0
1 To: git@vger.kernel.org
2 Subject: A note from the maintainer
4 Welcome to the Git development community.
6 This message is written by the maintainer and talks about how Git
7 project is managed, and how you can work with it.
9 * Mailing list and the community
11 The development is primarily done on the Git mailing list. Help
12 requests, feature proposals, bug reports and patches should be sent to
13 the list address <git@vger.kernel.org>.  You don't have to be
14 subscribed to send messages.  The convention on the list is to keep
15 everybody involved on Cc:, so it is unnecessary to say "Please Cc: me,
16 I am not subscribed".
18 As an anti-spam measure, the mailing list software rejects messages
19 that are not text/plain and drops them on the floor.  If you are a
20 GMail user, you'd want to make sure "Plain text mode" is checked.
22 Before sending patches, please read Documentation/SubmittingPatches
23 and Documentation/CodingGuidelines to familiarize yourself with the
24 project convention.
26 If you sent a patch and you did not hear any response from anybody for
27 several days, it could be that your patch was totally uninteresting,
28 but it also is possible that it was simply lost in the noise.  Please
29 do not hesitate to send a reminder message in such a case.  Messages
30 getting lost in the noise may be a sign that those who can evaluate
31 your patch don't have enough mental/time bandwidth to process them
32 right at the moment, and it often helps to wait until the list traffic
33 becomes calmer before sending such a reminder.
35 The list archive is available at a few public sites:
37         http://public-inbox.org/git/
38         http://marc.info/?l=git
39         http://www.spinics.net/lists/git/
41 For those who prefer to read it over NNTP:
43         nntp://news.public-inbox.org/inbox.comp.version-control.git
44         nntp://news.gmane.org/gmane.comp.version-control.git
46 are available.
48 When you point at a message in a mailing list archive, using its
49 message ID is often the most robust (if not very friendly) way to do
50 so, like this:
52         http://public-inbox.org/git/Pine.LNX.4.58.0504150753440.7211@ppc970.osdl.org
54 Often these web interfaces accept the message ID with enclosing <>
55 stripped (like the above example to point at one of the most important
56 message in the Git list).
58 Some members of the development community can sometimes be found on
59 the #git and #git-devel IRC channels on Freenode.  Their logs are
60 available at:
62         http://colabti.org/irclogger/irclogger_log/git
63         http://colabti.org/irclogger/irclogger_log/git-devel
65 There is a volunteer-run newsletter to serve our community ("Git Rev
66 News" http://git.github.io/rev_news/rev_news.html).
68 Git is a member project of software freedom conservancy, a non-profit
69 organization (https://sfconservancy.org/).  To reach a committee of
70 liaisons to the conservancy, contact them at <git@sfconservancy.org>.
73 * Reporting bugs
75 When you think git does not behave as you expect, please do not stop
76 your bug report with just "git does not work".  "I used git in this
77 way, but it did not work" is not much better, neither is "I used git
78 in this way, and X happend, which is broken".  It often is that git is
79 correct to cause X happen in such a case, and it is your expectation
80 that is broken. People would not know what other result Y you expected
81 to see instead of X, if you left it unsaid.
83 Please remember to always state
85  - what you wanted to achieve;
87  - what you did (the version of git and the command sequence to reproduce
88    the behavior);
90  - what you saw happen (X above);
92  - what you expected to see (Y above); and
94  - how the last two are different.
96 See http://www.chiark.greenend.org.uk/~sgtatham/bugs.html for further
97 hints.
99 If you think you found a security-sensitive issue and want to disclose
100 it to us without announcing it to wider public, please contact us at
101 our security mailing list <git-security@googlegroups.com>.  This is
102 a closed list that is limited to people who need to know early about
103 vulnerabilities, including:
105   - people triaging and fixing reported vulnerabilities
106   - people operating major git hosting sites with many users
107   - people packaging and distributing git to large numbers of people
109 where these issues are discussed without risk of the information
110 leaking out before we're ready to make public announcements.
113 * Repositories and documentation.
115 My public git.git repositories are (mirrored) at:
117   git://git.kernel.org/pub/scm/git/git.git/
118   https://kernel.googlesource.com/pub/scm/git/git
119   git://repo.or.cz/alt-git.git/
120   https://github.com/git/git/
121   git://git-core.git.sourceforge.net/gitroot/git-core/git-core/
123 This one shows not just the main integration branches, but also
124 individual topics broken out:
126   git://github.com/gitster/git/
128 A few web interfaces are found at:
130   http://git.kernel.org/cgit/git/git.git
131   https://kernel.googlesource.com/pub/scm/git/git
132   http://repo.or.cz/w/alt-git.git
134 Preformatted documentation from the tip of the "master" branch can be
135 found in:
137   git://git.kernel.org/pub/scm/git/git-{htmldocs,manpages}.git/
138   git://repo.or.cz/git-{htmldocs,manpages}.git/
139   https://github.com/gitster/git-{htmldocs,manpages}.git/
141 The manual pages formatted in HTML for the tip of 'master' can be
142 viewed online at:
144   https://git.github.io/htmldocs/git.html
147 * How various branches are used.
149 There are four branches in git.git repository that track the source tree
150 of git: "master", "maint", "next", and "pu".
152 The "master" branch is meant to contain what are very well tested and
153 ready to be used in a production setting.  Every now and then, a
154 "feature release" is cut from the tip of this branch.  They used to be
155 named with three dotted decimal digits (e.g. "1.8.5"), but recently we
156 switched the versioning scheme and "feature releases" are named with
157 three-dotted decimal digits that ends with ".0" (e.g. "1.9.0").
159 The last such release was 2.15 done on Oct 30th, 2017.  You can expect
160 that the tip of the "master" branch is always more stable than any of
161 the released versions.
163 Whenever a feature release is made, "maint" branch is forked off from
164 "master" at that point.  Obvious and safe fixes after a feature
165 release are applied to this branch and maintenance releases are cut
166 from it.  Usually the fixes are merged to the "master" branch first,
167 several days before merged to the "maint" branch, to reduce the chance
168 of last-minute issues.  The maintenance releases used to be named with
169 four dotted decimal, named after the feature release they are updates
170 to (e.g. "1.8.5.1" was the first maintenance release for "1.8.5"
171 feature release).  These days, maintenance releases are named by
172 incrementing the last digit of three-dotted decimal name (e.g. "2.12.1"
173 was the first maintenance release for the "2.12" series).
175 New features never go to the 'maint' branch.  It is merged into "master"
176 primarily to propagate the description in the release notes forward.
178 A new development does not usually happen on "master". When you send a
179 series of patches, after review on the mailing list, a separate topic
180 branch is forked from the tip of "master" (or somewhere older, especially
181 when the topic is about fixing an earlier bug) and your patches are queued
182 there, and kept out of "master" while people test it out. The quality of
183 topic branches are judged primarily by the mailing list discussions.
185 Topic branches that are in good shape are merged to the "next" branch. In
186 general, the "next" branch always contains the tip of "master".  It might
187 not be quite rock-solid, but is expected to work more or less without major
188 breakage. The "next" branch is where new and exciting things take place. A
189 topic that is in "next" is expected to be polished to perfection before it
190 is merged to "master".  Please help this process by building & using the
191 "next" branch for your daily work, and reporting any new bugs you find to
192 the mailing list, before the breakage is merged down to the "master".
194 The "pu" (proposed updates) branch bundles all the remaining topic
195 branches the maintainer happens to have seen.  There is no guarantee that
196 the maintainer has enough bandwidth to pick up any and all topics that
197 are remotely promising from the list traffic, so please do not read
198 too much into a topic being on (or not on) the "pu" branch.  This
199 branch is mainly to remind the maintainer that the topics in them may
200 turn out to be interesting when they are polished, nothing more.  The
201 topics on this branch aren't usually complete, well tested, or well
202 documented and they often need further work.  When a topic that was
203 in "pu" proves to be in a testable shape, it is merged to "next".
205 You can run "git log --first-parent master..pu" to see what topics are
206 currently in flight.  Sometimes, an idea that looked promising turns out
207 to be not so good and the topic can be dropped from "pu" in such a case.
208 The output of the above "git log" talks about a "jch" branch, which is an
209 early part of the "pu" branch; that branch contains all topics that
210 are in "next" and a bit more (but not all of "pu") and is used by the
211 maintainer for his daily work.
213 The two branches "master" and "maint" are never rewound, and "next"
214 usually will not be either.  After a feature release is made from
215 "master", however, "next" will be rebuilt from the tip of "master"
216 using the topics that didn't make the cut in the feature release.
218 A natural consequence of how "next" and "pu" bundles topics together
219 is that until a topic is merged to "next", updates to it is expected
220 by replacing the patch(es) in the topic with an improved version,
221 and once a topic is merged to "next", updates to it needs to come as
222 incremental patches, pointing out what was wrong in the previous
223 patches and how the problem was corrected.
225 Note that being in "next" is not a guarantee to appear in the next
226 release, nor even in any future release.  There were cases that topics
227 needed reverting a few commits in them before graduating to "master",
228 or a topic that already was in "next" was reverted from "next" because
229 fatal flaws were found in it after it was merged to "next".
232 * Other people's trees.
234 Documentation/SubmittingPatches outlines to whom your proposed changes
235 should be sent.  As described in contrib/README, I would delegate fixes
236 and enhancements in contrib/ area to the primary contributors of them.
238 Although the following are included in git.git repository, they have their
239 own authoritative repository and maintainers:
241  - git-gui/ comes from git-gui project, maintained by Pat Thoyts:
243         git://repo.or.cz/git-gui.git
245  - gitk-git/ comes from Paul Mackerras's gitk project:
247         git://ozlabs.org/~paulus/gitk
249  - po/ comes from the localization coordinator, Jiang Xin:
251         https://github.com/git-l10n/git-po/
253 When sending proposed updates and fixes to these parts of the system,
254 please base your patches on these trees, not git.git (the former two
255 even have different directory structures).