FM / git

/usr/share/doc/git

Name	Size	Mode	Actions
contrib/	-	0755	rm
howto/	-	0755	rm
RelNotes/	-	0755	rm
technical/	-	0755	rm
blame-options.txt	6001	0644	edit dl rm
cmds-ancillaryinterrogators.txt	1294	0644	edit dl rm
cmds-ancillarymanipulators.txt	746	0644	edit dl rm
cmds-developerinterfaces.txt	678	0644	edit dl rm
cmds-foreignscminterface.txt	399	0644	edit dl rm
cmds-guide.txt	833	0644	edit dl rm
cmds-mainporcelain.txt	3033	0644	edit dl rm
cmds-plumbinginterrogators.txt	1539	0644	edit dl rm
cmds-plumbingmanipulators.txt	1410	0644	edit dl rm
cmds-purehelpers.txt	1268	0644	edit dl rm
cmds-synchelpers.txt	449	0644	edit dl rm
cmds-synchingrepositories.txt	397	0644	edit dl rm
cmds-userinterfaces.txt	507	0644	edit dl rm
CODE_OF_CONDUCT.md	5989	0644	edit dl rm
config.txt	18001	0644	edit dl rm
date-formats.txt	1172	0644	edit dl rm
diff-format.txt	6573	0644	edit dl rm
diff-generate-patch.txt	7253	0644	edit dl rm
diff-options.txt	32436	0644	edit dl rm
docbook-xsl.css	4557	0644	edit dl rm
everyday.html	16996	0644	edit dl rm
fetch-options.txt	12281	0644	edit dl rm
fsck-msgids.txt	4197	0644	edit dl rm
git-add.html	40369	0644	edit dl rm
git-add.txt	16164	0644	edit dl rm
git-am.html	33161	0644	edit dl rm
git-am.txt	9317	0644	edit dl rm
git-annotate.html	28391	0644	edit dl rm
git-annotate.txt	771	0644	edit dl rm
git-apply.html	33407	0644	edit dl rm
git-apply.txt	10950	0644	edit dl rm
git-archive.html	29856	0644	edit dl rm
git-archive.txt	8491	0644	edit dl rm
git-bisect-lk2009.html	81243	0644	edit dl rm
git-bisect-lk2009.txt	49694	0644	edit dl rm
git-bisect.html	40572	0644	edit dl rm
git-bisect.txt	17905	0644	edit dl rm
git-blame.html	42501	0644	edit dl rm
git-blame.txt	8732	0644	edit dl rm
git-branch.html	48253	0644	edit dl rm
git-branch.txt	15748	0644	edit dl rm
git-bugreport.html	20509	0644	edit dl rm
git-bugreport.txt	2421	0644	edit dl rm
git-bundle.html	33269	0644	edit dl rm
git-bundle.txt	11703	0644	edit dl rm
git-cat-file.html	38661	0644	edit dl rm
git-cat-file.txt	13615	0644	edit dl rm
git-check-attr.html	22633	0644	edit dl rm
git-check-attr.txt	3390	0644	edit dl rm
git-check-ignore.html	23135	0644	edit dl rm
git-check-ignore.txt	4156	0644	edit dl rm
git-check-mailmap.html	18816	0644	edit dl rm
git-check-mailmap.txt	1108	0644	edit dl rm
git-check-ref-format.html	24040	0644	edit dl rm
git-check-ref-format.txt	5034	0644	edit dl rm
git-checkout-index.html	25362	0644	edit dl rm
git-checkout-index.txt	5669	0644	edit dl rm
git-checkout.html	52719	0644	edit dl rm
git-checkout.txt	22362	0644	edit dl rm
git-cherry-pick.html	31065	0644	edit dl rm
git-cherry-pick.txt	8764	0644	edit dl rm
git-cherry.html	22423	0644	edit dl rm
git-cherry.txt	3615	0644	edit dl rm
git-clean.html	23981	0644	edit dl rm
git-clean.txt	4523	0644	edit dl rm
git-clone.html	44328	0644	edit dl rm
git-clone.txt	14772	0644	edit dl rm
git-column.html	23317	0644	edit dl rm
git-column.txt	2201	0644	edit dl rm
git-commit-graph.html	26147	0644	edit dl rm
git-commit-graph.txt	5949	0644	edit dl rm
git-commit-tree.html	26683	0644	edit dl rm
git-commit-tree.txt	2710	0644	edit dl rm
git-commit.html	57154	0644	edit dl rm
git-commit.txt	21575	0644	edit dl rm
git-config.html	415540	0644	edit dl rm
git-config.txt	19755	0644	edit dl rm
git-contacts.html	20718	0644	edit dl rm
git-contacts.txt	2584	0644	edit dl rm
git-count-objects.html	18946	0644	edit dl rm
git-count-objects.txt	1350	0644	edit dl rm
git-credential-cache--daemon.html	18182	0644	edit dl rm
git-credential-cache--daemon.txt	891	0644	edit dl rm
git-credential-cache.html	20180	0644	edit dl rm
git-credential-cache.txt	2484	0644	edit dl rm
git-credential-store.html	22043	0644	edit dl rm
git-credential-store.txt	3637	0644	edit dl rm
git-credential.html	26676	0644	edit dl rm
git-credential.txt	7327	0644	edit dl rm
git-describe.html	28268	0644	edit dl rm
git-describe.txt	8319	0644	edit dl rm
git-diagnose.html	20157	0644	edit dl rm
git-diagnose.txt	2208	0644	edit dl rm
git-diff-files.html	79130	0644	edit dl rm
git-diff-files.txt	1225	0644	edit dl rm
git-diff-index.html	84351	0644	edit dl rm
git-diff-index.txt	4811	0644	edit dl rm
git-diff-tree.html	116052	0644	edit dl rm
git-diff-tree.txt	4184	0644	edit dl rm
git-diff.html	107093	0644	edit dl rm
git-diff.txt	8039	0644	edit dl rm
git-difftool.html	27048	0644	edit dl rm
git-difftool.txt	4624	0644	edit dl rm
git-fast-export.html	31650	0644	edit dl rm
git-fast-export.txt	11282	0644	edit dl rm
git-fast-import.html	103283	0644	edit dl rm
git-fast-import.txt	59963	0644	edit dl rm
git-fetch-pack.html	23255	0644	edit dl rm
git-fetch-pack.txt	4248	0644	edit dl rm
git-fetch.html	75456	0644	edit dl rm
git-fetch.txt	11812	0644	edit dl rm
git-filter-branch.html	54648	0644	edit dl rm
git-filter-branch.txt	31031	0644	edit dl rm
git-fmt-merge-msg.html	21435	0644	edit dl rm
git-fmt-merge-msg.txt	1931	0644	edit dl rm
git-for-each-ref.html	43438	0644	edit dl rm
git-for-each-ref.txt	17073	0644	edit dl rm
git-for-each-repo.html	19296	0644	edit dl rm
git-for-each-repo.txt	1543	0644	edit dl rm
git-format-patch.html	81842	0644	edit dl rm
git-format-patch.txt	28876	0644	edit dl rm
git-fsck-objects.html	17392	0644	edit dl rm
git-fsck-objects.txt	354	0644	edit dl rm
git-fsck.html	39162	0644	edit dl rm
git-fsck.txt	5882	0644	edit dl rm
git-fsmonitor--daemon.html	22875	0644	edit dl rm
git-fsmonitor--daemon.txt	3610	0644	edit dl rm
git-gc.html	36697	0644	edit dl rm
git-gc.txt	6292	0644	edit dl rm
git-get-tar-commit-id.html	17835	0644	edit dl rm
git-get-tar-commit-id.txt	753	0644	edit dl rm
git-grep.html	36030	0644	edit dl rm
git-grep.txt	10763	0644	edit dl rm
git-hash-object.html	19939	0644	edit dl rm
git-hash-object.txt	2142	0644	edit dl rm
git-help.html	28141	0644	edit dl rm
git-help.txt	7527	0644	edit dl rm
git-hook.html	18807	0644	edit dl rm
git-hook.txt	1028	0644	edit dl rm
git-http-backend.html	30974	0644	edit dl rm
git-http-backend.txt	11472	0644	edit dl rm
git-http-fetch.html	19679	0644	edit dl rm
git-http-fetch.txt	1775	0644	edit dl rm
git-http-push.html	21391	0644	edit dl rm
git-http-push.txt	2995	0644	edit dl rm
git-imap-send.html	25472	0644	edit dl rm
git-imap-send.txt	3567	0644	edit dl rm
git-index-pack.html	24735	0644	edit dl rm
git-index-pack.txt	5205	0644	edit dl rm
git-init-db.html	17460	0644	edit dl rm
git-init-db.txt	409	0644	edit dl rm
git-init.html	26604	0644	edit dl rm
git-init.txt	5869	0644	edit dl rm
git-interpret-trailers.html	42006	0644	edit dl rm
git-interpret-trailers.txt	18579	0644	edit dl rm
git-log.html	182485	0644	edit dl rm
git-log.txt	6864	0644	edit dl rm
git-ls-files.html	35053	0644	edit dl rm
git-ls-files.txt	11622	0644	edit dl rm
git-ls-remote.html	24349	0644	edit dl rm
git-ls-remote.txt	4841	0644	edit dl rm
git-ls-tree.html	25628	0644	edit dl rm
git-ls-tree.txt	5515	0644	edit dl rm
git-mailinfo.html	23402	0644	edit dl rm
git-mailinfo.txt	3866	0644	edit dl rm
git-mailsplit.html	19264	0644	edit dl rm
git-mailsplit.txt	1342	0644	edit dl rm
git-maintenance.html	46000	0644	edit dl rm
git-maintenance.txt	18901	0644	edit dl rm
git-merge-base.html	28380	0644	edit dl rm
git-merge-base.txt	7759	0644	edit dl rm
git-merge-file.html	22656	0644	edit dl rm
git-merge-file.txt	3718	0644	edit dl rm
git-merge-index.html	20450	0644	edit dl rm
git-merge-index.txt	2445	0644	edit dl rm
git-merge-one-file.html	17416	0644	edit dl rm
git-merge-one-file.txt	387	0644	edit dl rm
git-merge-tree.html	33496	0644	edit dl rm
git-merge-tree.txt	11923	0644	edit dl rm
git-merge.html	71005	0644	edit dl rm
git-merge.txt	15068	0644	edit dl rm
git-mergetool--lib.html	19127	0644	edit dl rm
git-mergetool--lib.txt	1467	0644	edit dl rm
git-mergetool.html	39795	0644	edit dl rm
git-mergetool.txt	4473	0644	edit dl rm
git-mktag.html	19819	0644	edit dl rm
git-mktag.txt	1782	0644	edit dl rm
git-mktree.html	18474	0644	edit dl rm
git-mktree.txt	1075	0644	edit dl rm
git-multi-pack-index.html	23595	0644	edit dl rm
git-multi-pack-index.txt	4632	0644	edit dl rm
git-mv.html	20092	0644	edit dl rm
git-mv.txt	2103	0644	edit dl rm
git-name-rev.html	21670	0644	edit dl rm
git-name-rev.txt	3352	0644	edit dl rm
git-notes.html	41046	0644	edit dl rm
git-notes.txt	13866	0644	edit dl rm
git-pack-objects.html	42391	0644	edit dl rm
git-pack-objects.txt	19297	0644	edit dl rm
git-pack-redundant.html	19799	0644	edit dl rm
git-pack-redundant.txt	1876	0644	edit dl rm
git-pack-refs.html	21120	0644	edit dl rm
git-pack-refs.txt	3136	0644	edit dl rm
git-patch-id.html	20354	0644	edit dl rm
git-patch-id.txt	2430	0644	edit dl rm
git-prune-packed.html	18539	0644	edit dl rm
git-prune-packed.txt	946	0644	edit dl rm
git-prune.html	20327	0644	edit dl rm
git-prune.txt	1919	0644	edit dl rm
git-pull.html	77070	0644	edit dl rm
git-pull.txt	8354	0644	edit dl rm
git-push.html	74993	0644	edit dl rm
git-push.txt	28061	0644	edit dl rm
git-quiltimport.html	19466	0644	edit dl rm
git-quiltimport.txt	1693	0644	edit dl rm
git-range-diff.html	31673	0644	edit dl rm
git-range-diff.txt	10337	0644	edit dl rm
git-read-tree.html	39078	0644	edit dl rm
git-read-tree.txt	16897	0644	edit dl rm
git-rebase.html	98945	0644	edit dl rm
git-rebase.txt	47228	0644	edit dl rm
git-receive-pack.html	30448	0644	edit dl rm
git-receive-pack.txt	9526	0644	edit dl rm
git-reflog.html	23514	0644	edit dl rm
git-reflog.txt	4575	0644	edit dl rm
git-remote-ext.html	23012	0644	edit dl rm
git-remote-ext.txt	3977	0644	edit dl rm
git-remote-fd.html	19501	0644	edit dl rm
git-remote-fd.txt	1628	0644	edit dl rm
git-remote-helpers.html	16974	0644	edit dl rm
git-remote.html	29903	0644	edit dl rm
git-remote.txt	8768	0644	edit dl rm
git-repack.html	32819	0644	edit dl rm
git-repack.txt	11020	0644	edit dl rm
git-replace.html	24858	0644	edit dl rm
git-replace.txt	5211	0644	edit dl rm
git-request-pull.html	20295	0644	edit dl rm
git-request-pull.txt	2035	0644	edit dl rm
git-rerere.html	27040	0644	edit dl rm
git-rerere.txt	7781	0644	edit dl rm
git-reset.html	44520	0644	edit dl rm
git-reset.txt	19125	0644	edit dl rm
git-restore.html	28166	0644	edit dl rm
git-restore.txt	7082	0644	edit dl rm
git-rev-list.html	118128	0644	edit dl rm
git-rev-list.txt	3220	0644	edit dl rm
git-rev-parse.html	64641	0644	edit dl rm
git-rev-parse.txt	15840	0644	edit dl rm
git-revert.html	26792	0644	edit dl rm
git-revert.txt	5421	0644	edit dl rm
git-rm.html	27584	0644	edit dl rm
git-rm.txt	7236	0644	edit dl rm
git-send-pack.html	24576	0644	edit dl rm
git-send-pack.txt	5160	0644	edit dl rm
git-sh-i18n--envsubst.html	18166	0644	edit dl rm
git-sh-i18n--envsubst.txt	928	0644	edit dl rm
git-sh-i18n.html	18595	0644	edit dl rm
git-sh-i18n.txt	1147	0644	edit dl rm
git-sh-setup.html	21277	0644	edit dl rm
git-sh-setup.txt	2976	0644	edit dl rm
git-shell.html	21414	0644	edit dl rm
git-shell.txt	2981	0644	edit dl rm
git-shortlog.html	64618	0644	edit dl rm
git-shortlog.txt	4409	0644	edit dl rm
git-show-branch.html	26813	0644	edit dl rm
git-show-branch.txt	6589	0644	edit dl rm
git-show-index.html	19521	0644	edit dl rm
git-show-index.txt	1473	0644	edit dl rm
git-show-ref.html	26075	0644	edit dl rm
git-show-ref.txt	6648	0644	edit dl rm
git-show.html	111644	0644	edit dl rm
git-show.txt	1929	0644	edit dl rm
git-sparse-checkout.html	43949	0644	edit dl rm
git-sparse-checkout.txt	21258	0644	edit dl rm
git-stage.html	17341	0644	edit dl rm
git-stage.txt	299	0644	edit dl rm
git-stash.html	38594	0644	edit dl rm
git-stash.txt	14999	0644	edit dl rm
git-status.html	45718	0644	edit dl rm
git-status.txt	20295	0644	edit dl rm
git-stripspace.html	20016	0644	edit dl rm
git-stripspace.txt	1946	0644	edit dl rm
git-submodule.html	45581	0644	edit dl rm
git-submodule.txt	20819	0644	edit dl rm
git-subtree.html	36823	0644	edit dl rm
git-subtree.txt	13687	0644	edit dl rm
git-switch.html	33314	0644	edit dl rm
git-switch.txt	8607	0644	edit dl rm
git-symbolic-ref.html	20452	0644	edit dl rm
git-symbolic-ref.txt	2327	0644	edit dl rm
git-tag.html	38958	0644	edit dl rm
git-tag.txt	13469	0644	edit dl rm
git-tools.html	17207	0644	edit dl rm
git-tools.txt	422	0644	edit dl rm
git-unpack-file.html	17645	0644	edit dl rm
git-unpack-file.txt	434	0644	edit dl rm
git-unpack-objects.html	18811	0644	edit dl rm
git-unpack-objects.txt	1220	0644	edit dl rm
git-update-index.html	49723	0644	edit dl rm
git-update-index.txt	23928	0644	edit dl rm
git-update-ref.html	25909	0644	edit dl rm
git-update-ref.txt	6298	0644	edit dl rm
git-update-server-info.html	18255	0644	edit dl rm
git-update-server-info.txt	801	0644	edit dl rm
git-upload-archive.html	19776	0644	edit dl rm
git-upload-archive.txt	2087	0644	edit dl rm
git-upload-pack.html	21671	0644	edit dl rm
git-upload-pack.txt	2998	0644	edit dl rm
git-var.html	21537	0644	edit dl rm
git-var.txt	3176	0644	edit dl rm
git-verify-commit.html	17948	0644	edit dl rm
git-verify-commit.txt	575	0644	edit dl rm
git-verify-pack.html	18953	0644	edit dl rm
git-verify-pack.txt	1111	0644	edit dl rm
git-verify-tag.html	17941	0644	edit dl rm
git-verify-tag.txt	562	0644	edit dl rm
git-version.html	17798	0644	edit dl rm
git-version.txt	532	0644	edit dl rm
git-web--browse.html	22405	0644	edit dl rm
git-web--browse.txt	3576	0644	edit dl rm
git-whatchanged.html	18572	0644	edit dl rm
git-whatchanged.txt	1098	0644	edit dl rm
git-worktree.html	46341	0644	edit dl rm
git-worktree.txt	20985	0644	edit dl rm
git-write-tree.html	18441	0644	edit dl rm
git-write-tree.txt	1026	0644	edit dl rm
git.html	107237	0644	edit dl rm
git.txt	43254	0644	edit dl rm
gitattributes.html	82845	0644	edit dl rm
gitattributes.txt	49511	0644	edit dl rm
gitcli.html	29584	0644	edit dl rm
gitcli.txt	9697	0644	edit dl rm
gitcore-tutorial.html	100139	0644	edit dl rm
gitcore-tutorial.txt	62240	0644	edit dl rm
gitcredentials.html	31980	0644	edit dl rm
gitcredentials.txt	11317	0644	edit dl rm
gitdiffcore.html	33745	0644	edit dl rm
gitdiffcore.txt	14082	0644	edit dl rm
giteveryday.html	38092	0644	edit dl rm
giteveryday.txt	14422	0644	edit dl rm
gitfaq.html	44081	0644	edit dl rm
gitfaq.txt	21069	0644	edit dl rm
gitformat-bundle.html	21446	0644	edit dl rm
gitformat-bundle.txt	3256	0644	edit dl rm
gitformat-chunk.html	24329	0644	edit dl rm
gitformat-chunk.txt	5560	0644	edit dl rm
gitformat-commit-graph.html	28630	0644	edit dl rm
gitformat-commit-graph.txt	7857	0644	edit dl rm
gitformat-index.html	40269	0644	edit dl rm
gitformat-index.txt	15180	0644	edit dl rm
gitformat-pack.html	49811	0644	edit dl rm
gitformat-pack.txt	23509	0644	edit dl rm
gitformat-signature.html	27362	0644	edit dl rm
gitformat-signature.txt	8093	0644	edit dl rm
gitglossary.html	64201	0644	edit dl rm
gitglossary.txt	358	0644	edit dl rm
githooks.html	56500	0644	edit dl rm
githooks.txt	29331	0644	edit dl rm
gitignore.html	28399	0644	edit dl rm
gitignore.txt	8918	0644	edit dl rm
gitmailmap.html	22819	0644	edit dl rm
gitmailmap.txt	3551	0644	edit dl rm
gitmodules.html	24057	0644	edit dl rm
gitmodules.txt	4800	0644	edit dl rm
gitnamespaces.html	22148	0644	edit dl rm
gitnamespaces.txt	2509	0644	edit dl rm
gitprotocol-capabilities.html	37425	0644	edit dl rm
gitprotocol-capabilities.txt	15311	0644	edit dl rm
gitprotocol-common.html	21565	0644	edit dl rm
gitprotocol-common.txt	3177	0644	edit dl rm
gitprotocol-http.html	43234	0644	edit dl rm
gitprotocol-http.txt	17994	0644	edit dl rm
gitprotocol-pack.html	53023	0644	edit dl rm
gitprotocol-pack.txt	27678	0644	edit dl rm
gitprotocol-v2.html	59690	0644	edit dl rm
gitprotocol-v2.txt	31434	0644	edit dl rm
gitremote-helpers.html	48215	0644	edit dl rm
gitremote-helpers.txt	21785	0644	edit dl rm
gitrepository-layout.html	39352	0644	edit dl rm
gitrepository-layout.txt	11622	0644	edit dl rm
gitrevisions.html	41621	0644	edit dl rm
gitrevisions.txt	823	0644	edit dl rm
gitsubmodules.html	31699	0644	edit dl rm
gitsubmodules.txt	10366	0644	edit dl rm
gittutorial-2.html	34547	0644	edit dl rm
gittutorial-2.txt	14750	0644	edit dl rm
gittutorial.html	46263	0644	edit dl rm
gittutorial.txt	22972	0644	edit dl rm
gitworkflows.html	39869	0644	edit dl rm
gitworkflows.txt	17414	0644	edit dl rm
glossary-content.txt	32609	0644	edit dl rm
howto-index.html	22991	0644	edit dl rm
howto-index.txt	4001	0644	edit dl rm
i18n.txt	2940	0644	edit dl rm
line-range-format.txt	1162	0644	edit dl rm
line-range-options.txt	761	0644	edit dl rm
merge-options.txt	7236	0644	edit dl rm
merge-strategies.txt	6610	0644	edit dl rm
mergetools-diff.txt	1507	0644	edit dl rm
mergetools-merge.txt	2586	0644	edit dl rm
MyFirstContribution.html	90572	0644	edit dl rm
MyFirstContribution.txt	54596	0644	edit dl rm
MyFirstObjectWalk.html	60554	0644	edit dl rm
MyFirstObjectWalk.txt	28979	0644	edit dl rm
object-format-disclaimer.txt	470	0644	edit dl rm
pretty-formats.txt	15669	0644	edit dl rm
pretty-options.txt	4201	0644	edit dl rm
pull-fetch-param.txt	5476	0644	edit dl rm
README.md	3652	0644	edit dl rm
ref-reachability-filters.txt	391	0644	edit dl rm
rerere-options.txt	414	0644	edit dl rm
rev-list-description.txt	2531	0644	edit dl rm
rev-list-options.txt	46906	0644	edit dl rm
ReviewingGuidelines.html	26831	0644	edit dl rm
ReviewingGuidelines.txt	8100	0644	edit dl rm
revisions.txt	17109	0644	edit dl rm
scalar.html	26055	0644	edit dl rm
scalar.txt	6056	0644	edit dl rm
sequencer.txt	472	0644	edit dl rm
signoff-option.txt	781	0644	edit dl rm
SubmittingPatches.html	55660	0644	edit dl rm
SubmittingPatches.txt	30147	0644	edit dl rm
ToolsForGit.html	19020	0644	edit dl rm
ToolsForGit.txt	1348	0644	edit dl rm
trace2-target-values.txt	529	0644	edit dl rm
transfer-data-leaks.txt	1712	0644	edit dl rm
urls-remotes.txt	2642	0644	edit dl rm
urls.txt	3634	0644	edit dl rm
user-manual.html	275731	0644	edit dl rm
user-manual.txt	173518	0644	edit dl rm

Edit: /usr/share/doc/git/SubmittingPatches.html (55660B)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<title>Submitting Patches</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */

/* Default font. */
body {
  font-family: Georgia,serif;
}

/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
  font-family: Arial,Helvetica,sans-serif;
}

body {
  margin: 1em 5% 1em 5%;
}

a {
  color: blue;
  text-decoration: underline;
}
a:visited {
  color: fuchsia;
}

em {
  font-style: italic;
  color: navy;
}

strong {
  font-weight: bold;
  color: #083194;
}

h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
}

h1, h2, h3 {
  border-bottom: 2px solid silver;
}
h2 {
  padding-top: 0.5em;
}
h3 {
  float: left;
}
h3 + * {
  clear: left;
}
h5 {
  font-size: 1.0em;
}

div.sectionbody {
  margin-left: 0;
}

hr {
  border: 1px solid silver;
}

p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
}

ul, ol, li > p {
  margin-top: 0;
}
ul > li     { color: #aaa; }
ul > li > * { color: black; }

.monospaced, code, pre {
  font-family: "Courier New", Courier, monospace;
  font-size: inherit;
  color: navy;
  padding: 0;
  margin: 0;
}
pre {
  white-space: pre-wrap;
}

#author {
  color: #527bbd;
  font-weight: bold;
  font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}

#footer {
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
}
#footer-text {
  float: left;
  padding-bottom: 0.5em;
}
#footer-badges {
  float: right;
  padding-bottom: 0.5em;
}

#preamble {
  margin-top: 1.5em;
  margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.admonitionblock {
  margin-top: 2.0em;
  margin-bottom: 2.0em;
  margin-right: 10%;
  color: #606060;
}

div.content { /* Block element content. */
  padding: 0;
}

/* Block element titles. */
div.title, caption.title {
  color: #527bbd;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
}
div.title + * {
  margin-top: 0;
}

td div.title:first-child {
  margin-top: 0.0em;
}
div.content div.title:first-child {
  margin-top: 0.0em;
}
div.content + div.title {
  margin-top: 0.0em;
}

div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid #dddddd;
  border-left: 4px solid #f0f0f0;
  padding: 0.5em;
}

div.listingblock > div.content {
  border: 1px solid #dddddd;
  border-left: 5px solid #f0f0f0;
  background: #f8f8f8;
  padding: 0.5em;
}

div.quoteblock, div.verseblock {
  padding-left: 1.0em;
  margin-left: 1.0em;
  margin-right: 10%;
  border-left: 5px solid #f0f0f0;
  color: #888;
}

div.quoteblock > div.attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock > pre.content {
  font-family: inherit;
  font-size: inherit;
}
div.verseblock > div.attribution {
  padding-top: 0.75em;
  text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
  text-align: left;
}

div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
}
div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 3px solid #dddddd;
}

div.exampleblock > div.content {
  border-left: 3px solid #dddddd;
  padding-left: 0.5em;
}

div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }

dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: normal;
  color: navy;
}
dd > *:first-child {
  margin-top: 0.1em;
}

ul, ol {
    list-style-position: outside;
}
ol.arabic {
  list-style-type: decimal;
}
ol.loweralpha {
  list-style-type: lower-alpha;
}
ol.upperalpha {
  list-style-type: upper-alpha;
}
ol.lowerroman {
  list-style-type: lower-roman;
}
ol.upperroman {
  list-style-type: upper-roman;
}

div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
  margin-top: 0.1em;
  margin-bottom: 0.1em;
}

tfoot {
  font-weight: bold;
}
td > div.verse {
  white-space: pre;
}

div.hdlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
div.hdlist tr {
  padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
  font-weight: bold;
}
td.hdlist1 {
  vertical-align: top;
  font-style: normal;
  padding-right: 0.8em;
  color: navy;
}
td.hdlist2 {
  vertical-align: top;
}
div.hdlist.compact tr {
  margin: 0;
  padding-bottom: 0;
}

.comment {
  background: yellow;
}

.footnote, .footnoteref {
  font-size: 0.8em;
}

span.footnote, span.footnoteref {
  vertical-align: super;
}

#footnotes {
  margin: 20px 0 20px 0;
  padding: 7px 0 0 0;
}

#footnotes div.footnote {
  margin: 0 0 5px 0;
}

#footnotes hr {
  border: none;
  border-top: 1px solid silver;
  height: 1px;
  text-align: left;
  margin-left: 0;
  width: 20%;
  min-width: 100px;
}

div.colist td {
  padding-right: 0.5em;
  padding-bottom: 0.3em;
  vertical-align: top;
}
div.colist td img {
  margin-top: 0.3em;
}

@media print {
  #footer-badges { display: none; }
}

#toc {
  margin-bottom: 2.5em;
}

#toctitle {
  color: #527bbd;
  font-size: 1.1em;
  font-weight: bold;
  margin-top: 1.0em;
  margin-bottom: 0.1em;
}

div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  margin-top: 0;
  margin-bottom: 0;
}
div.toclevel2 {
  margin-left: 2em;
  font-size: 0.9em;
}
div.toclevel3 {
  margin-left: 4em;
  font-size: 0.9em;
}
div.toclevel4 {
  margin-left: 6em;
  font-size: 0.9em;
}

span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }

span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }

span.big { font-size: 2em; }
span.small { font-size: 0.6em; }

span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }

div.unbreakable { page-break-inside: avoid; }

/*
 * xhtml11 specific
 *
 * */

div.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.tableblock > table {
  border: 3px solid #527bbd;
}
thead, p.table.header {
  font-weight: bold;
  color: #527bbd;
}
p.table {
  margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
  border-style: none;
}
div.tableblock > table[frame="hsides"] {
  border-left-style: none;
  border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
  border-top-style: none;
  border-bottom-style: none;
}

/*
 * html5 specific
 *
 * */

table.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
thead, p.tableblock.header {
  font-weight: bold;
  color: #527bbd;
}
p.tableblock {
  margin-top: 0;
}
table.tableblock {
  border-width: 3px;
  border-spacing: 0px;
  border-style: solid;
  border-color: #527bbd;
  border-collapse: collapse;
}
th.tableblock, td.tableblock {
  border-width: 1px;
  padding: 4px;
  border-style: solid;
  border-color: #527bbd;
}

table.tableblock.frame-topbot {
  border-left-style: hidden;
  border-right-style: hidden;
}
table.tableblock.frame-sides {
  border-top-style: hidden;
  border-bottom-style: hidden;
}
table.tableblock.frame-none {
  border-style: hidden;
}

th.tableblock.halign-left, td.tableblock.halign-left {
  text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
  text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
  text-align: right;
}

th.tableblock.valign-top, td.tableblock.valign-top {
  vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
  vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
  vertical-align: bottom;
}

/*
 * manpage specific
 *
 * */

body.manpage h1 {
  padding-top: 0.5em;
  padding-bottom: 0.5em;
  border-top: 2px solid silver;
  border-bottom: 2px solid silver;
}
body.manpage h2 {
  border-style: none;
}
body.manpage div.sectionbody {
  margin-left: 3em;
}

@media print {
  body.manpage div#toc { display: none; }
}

</style>
<script type="text/javascript">
/*<![CDATA[*/
var asciidoc = {  // Namespace.

/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////

/* Author: Mihai Bazon, September 2002
 * http://students.infoiasi.ro/~mishoo
 *
 * Table Of Content generator
 * Version: 0.4
 *
 * Feel free to use this script under the terms of the GNU General Public
 * License, as long as you do not remove or alter this notice.
 */

/* modified by Troy D. Hanson, September 2006. License: GPL */
 /* modified by Stuart Rackham, 2006, 2009. License: GPL */

// toclevels = 1..4.
toc: function (toclevels) {

function getText(el) {
    var text = "";
    for (var i = el.firstChild; i != null; i = i.nextSibling) {
      if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
        text += i.data;
      else if (i.firstChild != null)
        text += getText(i);
    }
    return text;
  }

function TocEntry(el, text, toclevel) {
    this.element = el;
    this.text = text;
    this.toclevel = toclevel;
  }

var toc = document.getElementById("toc");
  if (!toc) {
    return;
  }

// Delete existing TOC entries in case we're reloading the TOC.
  var tocEntriesToRemove = [];
  var i;
  for (i = 0; i < toc.childNodes.length; i++) {
    var entry = toc.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div'
     && entry.getAttribute("class")
     && entry.getAttribute("class").match(/^toclevel/))
      tocEntriesToRemove.push(entry);
  }
  for (i = 0; i < tocEntriesToRemove.length; i++) {
    toc.removeChild(tocEntriesToRemove[i]);
  }

// Rebuild TOC entries.
  var entries = tocEntries(document.getElementById("content"), toclevels);
  for (var i = 0; i < entries.length; ++i) {
    var entry = entries[i];
    if (entry.element.id == "")
      entry.element.id = "_toc_" + i;
    var a = document.createElement("a");
    a.href = "#" + entry.element.id;
    a.appendChild(document.createTextNode(entry.text));
    var div = document.createElement("div");
    div.appendChild(a);
    div.className = "toclevel" + entry.toclevel;
    toc.appendChild(div);
  }
  if (entries.length == 0)
    toc.parentNode.removeChild(toc);
},

/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////

/* Based on footnote generation code from:
 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 */

footnotes: function () {
  // Delete existing footnote entries in case we're reloading the footnodes.
  var i;
  var noteholder = document.getElementById("footnotes");
  if (!noteholder) {
    return;
  }
  var entriesToRemove = [];
  for (i = 0; i < noteholder.childNodes.length; i++) {
    var entry = noteholder.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
      entriesToRemove.push(entry);
  }
  for (i = 0; i < entriesToRemove.length; i++) {
    noteholder.removeChild(entriesToRemove[i]);
  }

// Rebuild footnote entries.
  var cont = document.getElementById("content");
  var spans = cont.getElementsByTagName("span");
  var refs = {};
  var n = 0;
  for (i=0; i<spans.length; i++) {
    if (spans[i].className == "footnote") {
      n++;
      var note = spans[i].getAttribute("data-note");
      if (!note) {
        // Use [\s\S] in place of . so multi-line matches work.
        // Because JavaScript has no s (dotall) regex flag.
        note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
        spans[i].innerHTML =
          "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
        spans[i].setAttribute("data-note", note);
      }
      noteholder.innerHTML +=
        "<div class='footnote' id='_footnote_" + n + "'>" +
        "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
        n + "</a>. " + note + "</div>";
      var id =spans[i].getAttribute("id");
      if (id != null) refs["#"+id] = n;
    }
  }
  if (n == 0)
    noteholder.parentNode.removeChild(noteholder);
  else {
    // Process footnoterefs.
    for (i=0; i<spans.length; i++) {
      if (spans[i].className == "footnoteref") {
        var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
        href = href.match(/#.*/)[0];  // Because IE return full URL.
        n = refs[href];
        spans[i].innerHTML =
          "[<a href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
      }
    }
  }
},

install: function(toclevels) {
  var timerId;

function reinstall() {
    asciidoc.footnotes();
    if (toclevels) {
      asciidoc.toc(toclevels);
    }
  }

function reinstallAndRemoveTimer() {
    clearInterval(timerId);
    reinstall();
  }

timerId = setInterval(reinstall, 500);
  if (document.addEventListener)
    document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
  else
    window.onload = reinstallAndRemoveTimer;
}

}
asciidoc.install();
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>Submitting Patches</h1>
<span id="revdate"></span>
</div>
<div id="content">
<div class="sect1">
<h2 id="_guidelines">Guidelines</h2>
<div class="sectionbody">
<div class="paragraph"><p>Here are some guidelines for contributing back to this
project. There is also a <a href="MyFirstContribution.html">step-by-step tutorial</a>
available which covers many of these same guidelines.</p></div>
<div class="sect2">
<h3 id="choose-starting-point">Choose a starting point.</h3>
<div class="paragraph"><p>As a preliminary step, you must first choose a starting point for your
work. Typically this means choosing a branch, although technically
speaking it is actually a particular commit (typically the HEAD, or tip,
of the branch).</p></div>
<div class="paragraph"><p>There are several important branches to be aware of. Namely, there are
four integration branches as discussed in <a href="gitworkflows.html">gitworkflows(7)</a>:</p></div>
<div class="ulist"><ul>
<li>
<p>
maint
</p>
</li>
<li>
<p>
master
</p>
</li>
<li>
<p>
next
</p>
</li>
<li>
<p>
seen
</p>
</li>
</ul></div>
<div class="paragraph"><p>The branches lower on the list are typically descendants of the ones
that come before it. For example, <code>maint</code> is an "older" branch than
<code>master</code> because <code>master</code> usually has patches (commits) on top of
<code>maint</code>.</p></div>
<div class="paragraph"><p>There are also "topic" branches, which contain work from other
contributors.  Topic branches are created by the Git maintainer (in
their fork) to organize the current set of incoming contributions on
the mailing list, and are itemized in the regular "What&#8217;s cooking in
git.git" announcements.  To find the tip of a topic branch, run <code>git log
--first-parent master..seen</code> and look for the merge commit. The second
parent of this commit is the tip of the topic branch.</p></div>
<div class="paragraph"><p>There is one guiding principle for choosing the right starting point: in
general, always base your work on the oldest integration branch that
your change is relevant to (see "Merge upwards" in
<a href="gitworkflows.html">gitworkflows(7)</a>).  What this principle means is that for the
vast majority of cases, the starting point for new work should be the
latest HEAD commit of <code>maint</code> or <code>master</code> based on the following cases:</p></div>
<div class="ulist"><ul>
<li>
<p>
If you are fixing bugs in the released version, use <code>maint</code> as the
  starting point (which may mean you have to fix things without using
  new API features on the cutting edge that recently appeared in
  <code>master</code> but were not available in the released version).
</p>
</li>
<li>
<p>
Otherwise (such as if you are adding new features) use <code>master</code>.
</p>
</li>
</ul></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">In exceptional cases, a bug that was introduced in an old
version may have to be fixed for users of releases that are much older
than the recent releases.  <code>git describe --contains X</code> may describe
<code>X</code> as <code>v2.30.0-rc2-gXXXXXX</code> for the commit <code>X</code> that introduced the
bug, and the bug may be so high-impact that we may need to issue a new
maintenance release for Git 2.30.x series, when "Git 2.41.0" is the
current release.  In such a case, you may want to use the tip of the
maintenance branch for the 2.30.x series, which may be available in the
<code>maint-2.30</code> branch in <a href="https://github.com/gitster/git">the maintainer&#8217;s
"broken out" repo</a>.</td>
</tr></table>
</div>
<div class="paragraph"><p>This also means that <code>next</code> or <code>seen</code> are inappropriate starting points
for your work, if you want your work to have a realistic chance of
graduating to <code>master</code>.  They are simply not designed to be used as a
base for new work; they are only there to make sure that topics in
flight work well together. This is why both <code>next</code> and <code>seen</code> are
frequently re-integrated with incoming patches on the mailing list and
force-pushed to replace previous versions of themselves. A topic that is
literally built on top of <code>next</code> cannot be merged to <code>master</code> without
dragging in all the other topics in <code>next</code>, some of which may not be
ready.</p></div>
<div class="paragraph"><p>For example, if you are making tree-wide changes, while somebody else is
also making their own tree-wide changes, your work may have severe
overlap with the other person&#8217;s work.  This situation may tempt you to
use <code>next</code> as your starting point (because it would have the other
person&#8217;s work included in it), but doing so would mean you&#8217;ll not only
depend on the other person&#8217;s work, but all the other random things from
other contributors that are already integrated into <code>next</code>.  And as soon
as <code>next</code> is updated with a new version, all of your work will need to
be rebased anyway in order for them to be cleanly applied by the
maintainer.</p></div>
<div class="paragraph"><p>Under truly exceptional circumstances where you absolutely must depend
on a select few topic branches that are already in <code>next</code> but not in
<code>master</code>, you may want to create your own custom base-branch by forking
<code>master</code> and merging the required topic branches into it. You could then
work on top of this base-branch.  But keep in mind that this base-branch
would only be known privately to you.  So when you are ready to send
your patches to the list, be sure to communicate how you created it in
your cover letter.  This critical piece of information would allow
others to recreate your base-branch on their end in order for them to
try out your work.</p></div>
<div class="paragraph"><p>Finally, note that some parts of the system have dedicated maintainers
with their own separate source code repositories (see the section
"Subsystems" below).</p></div>
</div>
<div class="sect2">
<h3 id="separate-commits">Make separate commits for logically separate changes.</h3>
<div class="paragraph"><p>Unless your patch is really trivial, you should not be sending
out a patch that was generated between your working tree and
your commit head.  Instead, always make a commit with complete
commit message and generate a series of patches from your
repository.  It is a good discipline.</p></div>
<div class="paragraph"><p>Give an explanation for the change(s) that is detailed enough so
that people can judge if it is good thing to do, without reading
the actual patch text to determine how well the code does what
the explanation promises to do.</p></div>
<div class="paragraph"><p>If your description starts to get too long, that&#8217;s a sign that you
probably need to split up your commit to finer grained pieces.
That being said, patches which plainly describe the things that
help reviewers check the patch, and future maintainers understand
the code, are the most beautiful patches.  Descriptions that summarize
the point in the subject well, and describe the motivation for the
change, the approach taken by the change, and if relevant how this
differs substantially from the prior version, are all good things
to have.</p></div>
<div class="paragraph"><p>Make sure that you have tests for the bug you are fixing.  See
<code>t/README</code> for guidance.</p></div>
<div class="paragraph" id="tests"><p>When adding a new feature, make sure that you have new tests to show
the feature triggers the new behavior when it should, and to show the
feature does not trigger when it shouldn&#8217;t.  After any code change,
make sure that the entire test suite passes.  When fixing a bug, make
sure you have new tests that break if somebody else breaks what you
fixed by accident to avoid regression.  Also, try merging your work to
<em>next</em> and <em>seen</em> and make sure the tests still pass; topics by others
that are still in flight may have unexpected interactions with what
you are trying to do in your topic.</p></div>
<div class="paragraph"><p>Pushing to a fork of <a href="https://github.com/git/git">https://github.com/git/git</a> will use their CI
integration to test your changes on Linux, Mac and Windows. See the
<a href="#GHCI">GitHub CI</a> section for details.</p></div>
<div class="paragraph"><p>Do not forget to update the documentation to describe the updated
behavior and make sure that the resulting documentation set formats
well (try the Documentation/doc-diff script).</p></div>
<div class="paragraph"><p>We currently have a liberal mixture of US and UK English norms for
spelling and grammar, which is somewhat unfortunate.  A huge patch that
touches the files all over the place only to correct the inconsistency
is not welcome, though.  Potential clashes with other changes that can
result from such a patch are not worth it.  We prefer to gradually
reconcile the inconsistencies in favor of US English, with small and
easily digestible patches, as a side effect of doing some other real
work in the vicinity (e.g. rewriting a paragraph for clarity, while
turning en_UK spelling to en_US).  Obvious typographical fixes are much
more welcomed ("teh &#8594; "the"), preferably submitted as independent
patches separate from other documentation changes.</p></div>
<div class="paragraph" id="whitespace-check"><p>Oh, another thing.  We are picky about whitespaces.  Make sure your
changes do not trigger errors with the sample pre-commit hook shipped
in <code>templates/hooks--pre-commit</code>.  To help ensure this does not happen,
run <code>git diff --check</code> on your changes before you commit.</p></div>
</div>
<div class="sect2">
<h3 id="describe-changes">Describe your changes well.</h3>
<div class="paragraph"><p>The log message that explains your changes is just as important as the
changes themselves.  Your code may be clearly written with in-code
comment to sufficiently explain how it works with the surrounding
code, but those who need to fix or enhance your code in the future
will need to know <em>why</em> your code does what it does, for a few
reasons:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Your code may be doing something differently from what you wanted it
  to do.  Writing down what you actually wanted to achieve will help
  them fix your code and make it do what it should have been doing
  (also, you often discover your own bugs yourself, while writing the
  log message to summarize the thought behind it).
</p>
</li>
<li>
<p>
Your code may be doing things that were only necessary for your
  immediate needs (e.g. "do X to directories" without implementing or
  even designing what is to be done on files).  Writing down why you
  excluded what the code does not do will help guide future developers.
  Writing down "we do X to directories, because directories have
  characteristic Y" would help them infer "oh, files also have the same
  characteristic Y, so perhaps doing X to them would also make sense?".
  Saying "we don&#8217;t do the same X to files, because &#8230;" will help them
  decide if the reasoning is sound (in which case they do not waste
  time extending your code to cover files), or reason differently (in
  which case, they can explain why they extend your code to cover
  files, too).
</p>
</li>
</ol></div>
<div class="paragraph"><p>The goal of your log message is to convey the <em>why</em> behind your
change to help future developers.</p></div>
<div class="paragraph"><p>The first line of the commit message should be a short description (50
characters is the soft limit, see DISCUSSION in <a href="git-commit.html">git-commit(1)</a>),
and should skip the full stop.  It is also conventional in most cases to
prefix the first line with "area: " where the area is a filename or
identifier for the general area of the code being modified, e.g.</p></div>
<div class="ulist"><ul>
<li>
<p>
doc: clarify distinction between sign-off and pgp-signing
</p>
</li>
<li>
<p>
githooks.txt: improve the intro section
</p>
</li>
</ul></div>
<div class="paragraph"><p>If in doubt which identifier to use, run <code>git log --no-merges</code> on the
files you are modifying to see the current conventions.</p></div>
<div class="paragraph" id="summary-section"><p>The title sentence after the "area:" prefix omits the full stop at the
end, and its first word is not capitalized (the omission
of capitalization applies only to the word after the "area:"
prefix of the title) unless there is a reason to
capitalize it other than because it is the first word in the sentence.
E.g. "doc: clarify&#8230;", not "doc: Clarify&#8230;", or "githooks.txt:
improve&#8230;", not "githooks.txt: Improve&#8230;".  But "refs: HEAD is also
treated as a ref" is correct, as we spell <code>HEAD</code> in all caps even when
it appears in the middle of a sentence.</p></div>
<div class="paragraph" id="meaningful-message"><p>The body should provide a meaningful commit message, which:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
explains the problem the change tries to solve, i.e. what is wrong
  with the current code without the change.
</p>
</li>
<li>
<p>
justifies the way the change solves the problem, i.e. why the
  result with the change is better.
</p>
</li>
<li>
<p>
alternate solutions considered but discarded, if any.
</p>
</li>
</ol></div>
<div class="paragraph" id="present-tense"><p>The problem statement that describes the status quo is written in the
present tense.  Write "The code does X when it is given input Y",
instead of "The code used to do Y when given input X".  You do not
have to say "Currently"---the status quo in the problem statement is
about the code <em>without</em> your change, by project convention.</p></div>
<div class="paragraph" id="imperative-mood"><p>Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
to do frotz", as if you are giving orders to the codebase to change
its behavior.  Try to make sure your explanation can be understood
without external resources. Instead of giving a URL to a mailing list
archive, summarize the relevant points of the discussion.</p></div>
<div class="paragraph" id="commit-reference"><p>There are a few reasons why you may want to refer to another commit in
the "more stable" part of the history (i.e. on branches like <code>maint</code>,
<code>master</code>, and <code>next</code>):</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
A commit that introduced the root cause of a bug you are fixing.
</p>
</li>
<li>
<p>
A commit that introduced a feature that you are enhancing.
</p>
</li>
<li>
<p>
A commit that conflicts with your work when you made a trial merge
  of your work into <code>next</code> and <code>seen</code> for testing.
</p>
</li>
</ol></div>
<div class="paragraph"><p>When you reference a commit on a more stable branch (like <code>master</code>,
<code>maint</code> and <code>next</code>), use the format "abbreviated hash (subject,
date)", like this:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>        Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)
        noticed that ...</code></pre>
</div></div>
<div class="paragraph"><p>The "Copy commit reference" command of gitk can be used to obtain this
format (with the subject enclosed in a pair of double-quotes), or this
invocation of <code>git show</code>:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>        git show -s --pretty=reference &lt;commit&gt;</code></pre>
</div></div>
<div class="paragraph"><p>or, on an older version of Git without support for --pretty=reference:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>        git show -s --date=short --pretty='format:%h (%s, %ad)' &lt;commit&gt;</code></pre>
</div></div>
</div>
<div class="sect2">
<h3 id="sign-off">Certify your work by adding your <code>Signed-off-by</code> trailer</h3>
<div class="paragraph"><p>To improve tracking of who did what, we ask you to certify that you
wrote the patch or have the right to pass it on under the same license
as ours, by "signing off" your patch.  Without sign-off, we cannot
accept your patches.</p></div>
<div class="paragraph"><p>If (and only if) you certify the below D-C-O:</p></div>
<div class="quoteblock" id="dco">
<div class="title">Developer&#8217;s Certificate of Origin 1.1</div>
<div class="content">
<div class="paragraph"><p>By making a contribution to this project, I certify that:</p></div>
<div class="olist loweralpha"><ol class="loweralpha">
<li>
<p>
The contribution was created in whole or in part by me and I
   have the right to submit it under the open source license
   indicated in the file; or
</p>
</li>
<li>
<p>
The contribution is based upon previous work that, to the best
   of my knowledge, is covered under an appropriate open source
   license and I have the right under that license to submit that
   work with modifications, whether created in whole or in part
   by me, under the same open source license (unless I am
   permitted to submit under a different license), as indicated
   in the file; or
</p>
</li>
<li>
<p>
The contribution was provided directly to me by some other
   person who certified (a), (b) or (c) and I have not modified
   it.
</p>
</li>
<li>
<p>
I understand and agree that this project and the contribution
   are public and that a record of the contribution (including all
   personal information I submit with it, including my sign-off) is
   maintained indefinitely and may be redistributed consistent with
   this project or the open source license(s) involved.
</p>
</li>
</ol></div>
</div>
<div class="attribution">
</div></div>
<div class="paragraph"><p>you add a "Signed-off-by" trailer to your commit, that looks like
this:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>        Signed-off-by: Random J Developer &lt;random@developer.example.org&gt;</code></pre>
</div></div>
<div class="paragraph"><p>This line can be added by Git if you run the git-commit command with
the -s option.</p></div>
<div class="paragraph"><p>Notice that you can place your own <code>Signed-off-by</code> trailer when
forwarding somebody else&#8217;s patch with the above rules for
D-C-O.  Indeed you are encouraged to do so.  Do not forget to
place an in-body "From: " line at the beginning to properly attribute
the change to its true author (see (2) above).</p></div>
<div class="paragraph"><p>This procedure originally came from the Linux kernel project, so our
rule is quite similar to theirs, but what exactly it means to sign-off
your patch differs from project to project, so it may be different
from that of the project you are accustomed to.</p></div>
<div class="paragraph" id="real-name"><p>Also notice that a real name is used in the <code>Signed-off-by</code> trailer. Please
don&#8217;t hide your real name.</p></div>
<div class="paragraph" id="commit-trailers"><p>If you like, you can put extra tags at the end:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
<code>Reported-by:</code> is used to credit someone who found the bug that
  the patch attempts to fix.
</p>
</li>
<li>
<p>
<code>Acked-by:</code> says that the person who is more familiar with the area
  the patch attempts to modify liked the patch.
</p>
</li>
<li>
<p>
<code>Reviewed-by:</code>, unlike the other tags, can only be offered by the
  reviewers themselves when they are completely satisfied with the
  patch after a detailed analysis.
</p>
</li>
<li>
<p>
<code>Tested-by:</code> is used to indicate that the person applied the patch
  and found it to have the desired effect.
</p>
</li>
<li>
<p>
<code>Co-authored-by:</code> is used to indicate that people exchanged drafts
   of a patch before submitting it.
</p>
</li>
<li>
<p>
<code>Helped-by:</code> is used to credit someone who suggested ideas for
  changes without providing the precise changes in patch form.
</p>
</li>
<li>
<p>
<code>Mentored-by:</code> is used to credit someone with helping develop a
  patch as part of a mentorship program (e.g., GSoC or Outreachy).
</p>
</li>
<li>
<p>
<code>Suggested-by:</code> is used to credit someone with suggesting the idea
  for a patch.
</p>
</li>
</ol></div>
<div class="paragraph"><p>While you can also create your own trailer if the situation warrants it, we
encourage you to instead use one of the common trailers in this project
highlighted above.</p></div>
<div class="paragraph"><p>Only capitalize the very first letter of tags, i.e. favor
"Signed-off-by" over "Signed-Off-By" and "Acked-by:" over "Acked-By".</p></div>
</div>
<div class="sect2">
<h3 id="git-tools">Generate your patch using Git tools out of your commits.</h3>
<div class="paragraph"><p>Git based diff tools generate unidiff which is the preferred format.</p></div>
<div class="paragraph"><p>You do not have to be afraid to use <code>-M</code> option to <code>git diff</code> or
<code>git format-patch</code>, if your patch involves file renames.  The
receiving end can handle them just fine.</p></div>
<div class="paragraph" id="review-patch"><p>Please make sure your patch does not add commented out debugging code,
or include any extra files which do not relate to what your patch
is trying to achieve. Make sure to review
your patch after generating it, to ensure accuracy.  Before
sending out, please make sure it cleanly applies to the starting point you
have chosen in the "Choose a starting point" section.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">From the perspective of those reviewing your patch, the <code>master</code>
branch is the default expected starting point.  So if you have chosen a
different starting point, please communicate this choice in your cover
letter.</td>
</tr></table>
</div>
</div>
<div class="sect2">
<h3 id="send-patches">Sending your patches.</h3>
<div class="paragraph"><p>Before sending any patches, please note that patches that may be
security relevant should be submitted privately to the Git Security
mailing list<span class="footnote" id="_footnote_security-ml"><br />[The Git Security mailing list: <a href="mailto:git-security@googlegroups.com">git-security@googlegroups.com</a>]<br /></span>, instead of the public mailing list.</p></div>
<div class="paragraph"><p>Learn to use format-patch and send-email if possible.  These commands
are optimized for the workflow of sending patches, avoiding many ways
your existing e-mail client (often optimized for "multipart/*" MIME
type e-mails) might render your patches unusable.</p></div>
<div class="paragraph"><p>People on the Git mailing list need to be able to read and
comment on the changes you are submitting.  It is important for
a developer to be able to "quote" your changes, using standard
e-mail tools, so that they may comment on specific portions of
your code.  For this reason, each patch should be submitted
"inline" in a separate message.</p></div>
<div class="paragraph"><p>Multiple related patches should be grouped into their own e-mail
thread to help readers find all parts of the series.  To that end,
send them as replies to either an additional "cover letter" message
(see below), the first patch, or the respective preceding patch.</p></div>
<div class="paragraph"><p>If your log message (including your name on the
<code>Signed-off-by</code> trailer) is not writable in ASCII, make sure that
you send off a message in the correct encoding.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Warning</div>
</td>
<td class="content">Be wary of your MUAs word-wrap
corrupting your patch.  Do not cut-n-paste your patch; you can
lose tabs that way if you are not careful.</td>
</tr></table>
</div>
<div class="paragraph"><p>It is a common convention to prefix your subject line with
[PATCH].  This lets people easily distinguish patches from other
e-mail discussions.  Use of markers in addition to PATCH within
the brackets to describe the nature of the patch is also
encouraged.  E.g. [RFC PATCH] (where RFC stands for "request for
comments") is often used to indicate a patch needs further
discussion before being accepted, [PATCH v2], [PATCH v3] etc.
are often seen when you are sending an update to what you have
previously sent.</p></div>
<div class="paragraph"><p>The <code>git format-patch</code> command follows the best current practice to
format the body of an e-mail message.  At the beginning of the
patch should come your commit message, ending with the
<code>Signed-off-by</code> trailers, and a line that consists of three dashes,
followed by the diffstat information and the patch itself.  If
you are forwarding a patch from somebody else, optionally, at
the beginning of the e-mail message just before the commit
message starts, you can put a "From: " line to name that person.
To change the default "[PATCH]" in the subject to "[&lt;text&gt;]", use
<code>git format-patch --subject-prefix=&lt;text&gt;</code>.  As a shortcut, you
can use <code>--rfc</code> instead of <code>--subject-prefix="RFC PATCH"</code>, or
<code>-v &lt;n&gt;</code> instead of <code>--subject-prefix="PATCH v&lt;n&gt;"</code>.</p></div>
<div class="paragraph"><p>You often want to add additional explanation about the patch,
other than the commit message itself.  Place such "cover letter"
material between the three-dash line and the diffstat.  For
patches requiring multiple iterations of review and discussion,
an explanation of changes between each iteration can be kept in
Git-notes and inserted automatically following the three-dash
line via <code>git format-patch --notes</code>.</p></div>
<div class="paragraph" id="attachment"><p>Do not attach the patch as a MIME attachment, compressed or not.
Do not let your e-mail client send quoted-printable.  Do not let
your e-mail client send format=flowed which would destroy
whitespaces in your patches. Many
popular e-mail applications will not always transmit a MIME
attachment as plain text, making it impossible to comment on
your code.  A MIME attachment also takes a bit more time to
process.  This does not decrease the likelihood of your
MIME-attached change being accepted, but it makes it more likely
that it will be postponed.</p></div>
<div class="paragraph"><p>Exception:  If your mailer is mangling patches then someone may ask
you to re-send them using MIME, that is OK.</p></div>
<div class="paragraph" id="pgp-signature"><p>Do not PGP sign your patch. Most likely, your maintainer or other people on the
list would not have your PGP key and would not bother obtaining it anyway.
Your patch is not judged by who you are; a good patch from an unknown origin
has a far better chance of being accepted than a patch from a known, respected
origin that is done poorly or does incorrect things.</p></div>
<div class="paragraph"><p>If you really really really really want to do a PGP signed
patch, format it as "multipart/signed", not a text/plain message
that starts with <code>-----BEGIN PGP SIGNED MESSAGE-----</code>.  That is
not a text/plain, it&#8217;s something else.</p></div>
<div class="paragraph"><p>As mentioned at the beginning of the section, patches that may be
security relevant should not be submitted to the public mailing list
mentioned below, but should instead be sent privately to the Git
Security mailing list<span class="footnoteref"><br /><a href="#_footnote_security-ml">[security-ml]</a><br /></span>.</p></div>
<div class="paragraph"><p>Send your patch with "To:" set to the mailing list, with "cc:" listing
people who are involved in the area you are touching (the <code>git
contacts</code> command in <code>contrib/contacts/</code> can help to
identify them), to solicit comments and reviews.  Also, when you made
trial merges of your topic to <code>next</code> and <code>seen</code>, you may have noticed
work by others conflicting with your changes.  There is a good possibility
that these people may know the area you are touching well.</p></div>
<div class="paragraph"><p>After the list reached a consensus that it is a good idea to apply the
patch, re-send it with "To:" set to the maintainer<span class="footnote"><br />[The current maintainer: <a href="mailto:gitster@pobox.com">gitster@pobox.com</a>]<br /></span>
and "cc:" the list<span class="footnote"><br />[The mailing list: <a href="mailto:git@vger.kernel.org">git@vger.kernel.org</a>]<br /></span> for inclusion.  This is especially relevant
when the maintainer did not heavily participate in the discussion and
instead left the review to trusted others.</p></div>
<div class="paragraph"><p>Do not forget to add trailers such as <code>Acked-by:</code>, <code>Reviewed-by:</code> and
<code>Tested-by:</code> lines as necessary to credit people who helped your
patch, and "cc:" them when sending such a final version for inclusion.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_subsystems_with_dedicated_maintainers">Subsystems with dedicated maintainers</h2>
<div class="sectionbody">
<div class="paragraph"><p>Some parts of the system have dedicated maintainers with their own
repositories.</p></div>
<div class="ulist"><ul>
<li>
<p>
<code>git-gui/</code> comes from git-gui project, maintained by Pratyush Yadav:
</p>
<div class="literalblock">
<div class="content">
<pre><code>https://github.com/prati0100/git-gui.git</code></pre>
</div></div>
</li>
<li>
<p>
<code>gitk-git/</code> comes from Paul Mackerras&#8217;s gitk project:
</p>
<div class="literalblock">
<div class="content">
<pre><code>git://git.ozlabs.org/~paulus/gitk</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>Those who are interested in improving gitk can volunteer to help Paul
maintain it, cf. &lt;YntxL/fTplFm8lr6@cleo&gt;.</code></pre>
</div></div>
</li>
<li>
<p>
<code>po/</code> comes from the localization coordinator, Jiang Xin:
</p>
<div class="literalblock">
<div class="content">
<pre><code>https://github.com/git-l10n/git-po/</code></pre>
</div></div>
</li>
</ul></div>
<div class="paragraph"><p>Patches to these parts should be based on their trees.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="patch-flow">An ideal patch flow</h2>
<div class="sectionbody">
<div class="paragraph"><p>Here is an ideal patch flow for this project the current maintainer
suggests to the contributors:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
You come up with an itch.  You code it up.
</p>
</li>
<li>
<p>
Send it to the list and cc people who may need to know about
  the change.
</p>
<div class="paragraph"><p>The people who may need to know are the ones whose code you
are butchering.  These people happen to be the ones who are
most likely to be knowledgeable enough to help you, but
they have no obligation to help you (i.e. you ask for help,
don&#8217;t demand).  <code>git log -p &#45;&#45; <em>$area_you_are_modifying</em></code> would
help you find out who they are.</p></div>
</li>
<li>
<p>
You get comments and suggestions for improvements.  You may
  even get them in an "on top of your change" patch form.
</p>
</li>
<li>
<p>
Polish, refine, and re-send to the list and the people who
  spend their time to improve your patch.  Go back to step (2).
</p>
</li>
<li>
<p>
The list forms consensus that the last round of your patch is
  good.  Send it to the maintainer and cc the list.
</p>
</li>
<li>
<p>
A topic branch is created with the patch and is merged to <code>next</code>,
  and cooked further and eventually graduates to <code>master</code>.
</p>
</li>
</ol></div>
<div class="paragraph"><p>In any time between the (2)-(3) cycle, the maintainer may pick it up
from the list and queue it to <code>seen</code>, in order to make it easier for
people to play with it without having to pick up and apply the patch to
their trees themselves.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="patch-status">Know the status of your patch after submission</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
You can use Git itself to find out when your patch is merged in
  master. <code>git pull --rebase</code> will automatically skip already-applied
  patches, and will let you know. This works only if you rebase on top
  of the branch in which your patch has been merged (i.e. it will not
  tell you if your patch is merged in <code>seen</code> if you rebase on top of
  master).
</p>
</li>
<li>
<p>
Read the Git mailing list, the maintainer regularly posts messages
  entitled "What&#8217;s cooking in git.git" giving
  the status of various proposed changes.
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_github_ci_a_id_ghci_a">GitHub CI<a id="GHCI"></a></h2>
<div class="sectionbody">
<div class="paragraph"><p>With an account at GitHub, you can use GitHub CI to test your changes
on Linux, Mac and Windows. See
<a href="https://github.com/git/git/actions/workflows/main.yml">https://github.com/git/git/actions/workflows/main.yml</a> for examples of
recent CI runs.</p></div>
<div class="paragraph"><p>Follow these steps for the initial setup:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Fork <a href="https://github.com/git/git">https://github.com/git/git</a> to your GitHub account.
  You can find detailed instructions how to fork here:
  <a href="https://help.github.com/articles/fork-a-repo/">https://help.github.com/articles/fork-a-repo/</a>
</p>
</li>
</ol></div>
<div class="paragraph"><p>After the initial setup, CI will run whenever you push new changes
to your fork of Git on GitHub.  You can monitor the test state of all your
branches here: <code>https://github.com/&lt;Your GitHub handle&gt;/git/actions/workflows/main.yml</code></p></div>
<div class="paragraph"><p>If a branch does not pass all test cases then it will be marked with a
red <code>x</code>, instead of a green check. In that case, you can click on the
failing job and navigate to "ci/run-build-and-tests.sh" and/or
"ci/print-test-failures.sh". You can also download "Artifacts" which
are zip archives containing tarred (or zipped) archives with test data
relevant for debugging.</p></div>
<div class="paragraph"><p>Then fix the problem and push your fix to your GitHub fork. This will
trigger a new CI build to ensure all tests pass.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="mua">MUA specific hints</h2>
<div class="sectionbody">
<div class="paragraph"><p>Some of the patches I receive or pick up from the list share common
patterns of breakage.  Please make sure your MUA is set up
properly not to corrupt whitespaces.</p></div>
<div class="paragraph"><p>See the DISCUSSION section of <a href="git-format-patch.html">git-format-patch(1)</a> for hints on
checking your patch by mailing it to yourself and applying with
<a href="git-am.html">git-am(1)</a>.</p></div>
<div class="paragraph"><p>While you are at it, check the resulting commit log message from
a trial run of applying the patch.  If what is in the resulting
commit is not exactly what you would want to see, it is very
likely that your maintainer would end up hand editing the log
message when he applies your patch.  Things like "Hi, this is my
first patch.\n", if you really want to put in the patch e-mail,
should come after the three-dash line that signals the end of the
commit message.</p></div>
<div class="sect2">
<h3 id="_pine">Pine</h3>
<div class="paragraph"><p>(Johannes Schindelin)</p></div>
<div class="literalblock">
<div class="content">
<pre><code>I don't know how many people still use pine, but for those poor
souls it may be good to mention that the quell-flowed-text is
needed for recent versions.

... the "no-strip-whitespace-before-send" option, too. AFAIK it
was introduced in 4.60.</code></pre>
</div></div>
<div class="paragraph"><p>(Linus Torvalds)</p></div>
<div class="literalblock">
<div class="content">
<pre><code>And 4.58 needs at least this.

diff-tree 8326dd8350be64ac7fc805f6563a1d61ad10d32c (from e886a61f76edf5410573e92e38ce22974f9c40f1)
Author: Linus Torvalds &lt;torvalds@g5.osdl.org&gt;
Date:   Mon Aug 15 17:23:51 2005 -0700

Fix pine whitespace-corruption bug

There's no excuse for unconditionally removing whitespace from
    the pico buffers on close.

diff --git a/pico/pico.c b/pico/pico.c
--- a/pico/pico.c
+++ b/pico/pico.c
@@ -219,7 +219,9 @@ PICO *pm;
            switch(pico_all_done){      /* prepare for/handle final events */
              case COMP_EXIT :          /* already confirmed */
                packheader();
+#if 0
                stripwhitespace();
+#endif
                c |= COMP_EXIT;
                break;</code></pre>
</div></div>
<div class="paragraph"><p>(Daniel Barkalow)</p></div>
<div class="literalblock">
<div class="content">
<pre><code>&gt; A patch to SubmittingPatches, MUA specific help section for
&gt; users of Pine 4.63 would be very much appreciated.

Ah, it looks like a recent version changed the default behavior to do the
right thing, and inverted the sense of the configuration option. (Either
that or Gentoo did it.) So you need to set the
"no-strip-whitespace-before-send" option, unless the option you have is
"strip-whitespace-before-send", in which case you should avoid checking
it.</code></pre>
</div></div>
</div>
<div class="sect2">
<h3 id="_thunderbird_kmail_gmail">Thunderbird, KMail, GMail</h3>
<div class="paragraph"><p>See the MUA-SPECIFIC HINTS section of <a href="git-format-patch.html">git-format-patch(1)</a>.</p></div>
</div>
<div class="sect2">
<h3 id="_gnus">Gnus</h3>
<div class="paragraph"><p>"|" in the <code>*Summary*</code> buffer can be used to pipe the current
message to an external program, and this is a handy way to drive
<code>git am</code>.  However, if the message is MIME encoded, what is
piped into the program is the representation you see in your
<code>*Article*</code> buffer after unwrapping MIME.  This is often not what
you would want for two reasons.  It tends to screw up non-ASCII
characters (most notably in people&#8217;s names), and also
whitespaces (fatal in patches).  Running "C-u g" to display the
message in raw form before using "|" to run the pipe can work
this problem around.</p></div>
</div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated
 2025-06-13 22:14:31 UTC
</div>
</div>
</body>
</html>

Submitting Patches

Guidelines

Here are some guidelines for contributing back to this project. There is also a step-by-step tutorial available which covers many of these same guidelines.

Choose a starting point.

As a preliminary step, you must first choose a starting point for your work. Typically this means choosing a branch, although technically speaking it is actually a particular commit (typically the HEAD, or tip, of the branch).

There are several important branches to be aware of. Namely, there are four integration branches as discussed in gitworkflows(7):

maint
master
next
seen

The branches lower on the list are typically descendants of the ones that come before it. For example, maint is an "older" branch than master because master usually has patches (commits) on top of maint.

There are also "topic" branches, which contain work from other contributors. Topic branches are created by the Git maintainer (in their fork) to organize the current set of incoming contributions on the mailing list, and are itemized in the regular "What’s cooking in git.git" announcements. To find the tip of a topic branch, run git log --first-parent master..seen and look for the merge commit. The second parent of this commit is the tip of the topic branch.

There is one guiding principle for choosing the right starting point: in general, always base your work on the oldest integration branch that your change is relevant to (see "Merge upwards" in gitworkflows(7)). What this principle means is that for the vast majority of cases, the starting point for new work should be the latest HEAD commit of maint or master based on the following cases:

If you are fixing bugs in the released version, use maint as the starting point (which may mean you have to fix things without using new API features on the cutting edge that recently appeared in master but were not available in the released version).
Otherwise (such as if you are adding new features) use master.

Note

In exceptional cases, a bug that was introduced in an old version may have to be fixed for users of releases that are much older than the recent releases. git describe --contains X may describe X as v2.30.0-rc2-gXXXXXX for the commit X that introduced the bug, and the bug may be so high-impact that we may need to issue a new maintenance release for Git 2.30.x series, when "Git 2.41.0" is the current release. In such a case, you may want to use the tip of the maintenance branch for the 2.30.x series, which may be available in the maint-2.30 branch in the maintainer’s "broken out" repo.

This also means that next or seen are inappropriate starting points for your work, if you want your work to have a realistic chance of graduating to master. They are simply not designed to be used as a base for new work; they are only there to make sure that topics in flight work well together. This is why both next and seen are frequently re-integrated with incoming patches on the mailing list and force-pushed to replace previous versions of themselves. A topic that is literally built on top of next cannot be merged to master without dragging in all the other topics in next, some of which may not be ready.

For example, if you are making tree-wide changes, while somebody else is also making their own tree-wide changes, your work may have severe overlap with the other person’s work. This situation may tempt you to use next as your starting point (because it would have the other person’s work included in it), but doing so would mean you’ll not only depend on the other person’s work, but all the other random things from other contributors that are already integrated into next. And as soon as next is updated with a new version, all of your work will need to be rebased anyway in order for them to be cleanly applied by the maintainer.

Under truly exceptional circumstances where you absolutely must depend on a select few topic branches that are already in next but not in master, you may want to create your own custom base-branch by forking master and merging the required topic branches into it. You could then work on top of this base-branch. But keep in mind that this base-branch would only be known privately to you. So when you are ready to send your patches to the list, be sure to communicate how you created it in your cover letter. This critical piece of information would allow others to recreate your base-branch on their end in order for them to try out your work.

Finally, note that some parts of the system have dedicated maintainers with their own separate source code repositories (see the section "Subsystems" below).

Make separate commits for logically separate changes.

Unless your patch is really trivial, you should not be sending out a patch that was generated between your working tree and your commit head. Instead, always make a commit with complete commit message and generate a series of patches from your repository. It is a good discipline.

Give an explanation for the change(s) that is detailed enough so that people can judge if it is good thing to do, without reading the actual patch text to determine how well the code does what the explanation promises to do.

If your description starts to get too long, that’s a sign that you probably need to split up your commit to finer grained pieces. That being said, patches which plainly describe the things that help reviewers check the patch, and future maintainers understand the code, are the most beautiful patches. Descriptions that summarize the point in the subject well, and describe the motivation for the change, the approach taken by the change, and if relevant how this differs substantially from the prior version, are all good things to have.

Make sure that you have tests for the bug you are fixing. See t/README for guidance.

When adding a new feature, make sure that you have new tests to show the feature triggers the new behavior when it should, and to show the feature does not trigger when it shouldn’t. After any code change, make sure that the entire test suite passes. When fixing a bug, make sure you have new tests that break if somebody else breaks what you fixed by accident to avoid regression. Also, try merging your work to next and seen and make sure the tests still pass; topics by others that are still in flight may have unexpected interactions with what you are trying to do in your topic.

Pushing to a fork of https://github.com/git/git will use their CI integration to test your changes on Linux, Mac and Windows. See the GitHub CI section for details.

Do not forget to update the documentation to describe the updated behavior and make sure that the resulting documentation set formats well (try the Documentation/doc-diff script).

We currently have a liberal mixture of US and UK English norms for spelling and grammar, which is somewhat unfortunate. A huge patch that touches the files all over the place only to correct the inconsistency is not welcome, though. Potential clashes with other changes that can result from such a patch are not worth it. We prefer to gradually reconcile the inconsistencies in favor of US English, with small and easily digestible patches, as a side effect of doing some other real work in the vicinity (e.g. rewriting a paragraph for clarity, while turning en_UK spelling to en_US). Obvious typographical fixes are much more welcomed ("teh → "the"), preferably submitted as independent patches separate from other documentation changes.

Oh, another thing. We are picky about whitespaces. Make sure your changes do not trigger errors with the sample pre-commit hook shipped in templates/hooks--pre-commit. To help ensure this does not happen, run git diff --check on your changes before you commit.

Describe your changes well.

The log message that explains your changes is just as important as the changes themselves. Your code may be clearly written with in-code comment to sufficiently explain how it works with the surrounding code, but those who need to fix or enhance your code in the future will need to know why your code does what it does, for a few reasons:

Your code may be doing something differently from what you wanted it to do. Writing down what you actually wanted to achieve will help them fix your code and make it do what it should have been doing (also, you often discover your own bugs yourself, while writing the log message to summarize the thought behind it).
Your code may be doing things that were only necessary for your immediate needs (e.g. "do X to directories" without implementing or even designing what is to be done on files). Writing down why you excluded what the code does not do will help guide future developers. Writing down "we do X to directories, because directories have characteristic Y" would help them infer "oh, files also have the same characteristic Y, so perhaps doing X to them would also make sense?". Saying "we don’t do the same X to files, because …" will help them decide if the reasoning is sound (in which case they do not waste time extending your code to cover files), or reason differently (in which case, they can explain why they extend your code to cover files, too).

The goal of your log message is to convey the why behind your change to help future developers.

The first line of the commit message should be a short description (50 characters is the soft limit, see DISCUSSION in git-commit(1)), and should skip the full stop. It is also conventional in most cases to prefix the first line with "area: " where the area is a filename or identifier for the general area of the code being modified, e.g.

doc: clarify distinction between sign-off and pgp-signing
githooks.txt: improve the intro section

If in doubt which identifier to use, run git log --no-merges on the files you are modifying to see the current conventions.

The title sentence after the "area:" prefix omits the full stop at the end, and its first word is not capitalized (the omission of capitalization applies only to the word after the "area:" prefix of the title) unless there is a reason to capitalize it other than because it is the first word in the sentence. E.g. "doc: clarify…", not "doc: Clarify…", or "githooks.txt: improve…", not "githooks.txt: Improve…". But "refs: HEAD is also treated as a ref" is correct, as we spell HEAD in all caps even when it appears in the middle of a sentence.

The body should provide a meaningful commit message, which:

explains the problem the change tries to solve, i.e. what is wrong with the current code without the change.
justifies the way the change solves the problem, i.e. why the result with the change is better.
alternate solutions considered but discarded, if any.

The problem statement that describes the status quo is written in the present tense. Write "The code does X when it is given input Y", instead of "The code used to do Y when given input X". You do not have to say "Currently"---the status quo in the problem statement is about the code without your change, by project convention.

Describe your changes in imperative mood, e.g. "make xyzzy do frotz" instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy to do frotz", as if you are giving orders to the codebase to change its behavior. Try to make sure your explanation can be understood without external resources. Instead of giving a URL to a mailing list archive, summarize the relevant points of the discussion.

There are a few reasons why you may want to refer to another commit in the "more stable" part of the history (i.e. on branches like maint, master, and next):

A commit that introduced the root cause of a bug you are fixing.
A commit that introduced a feature that you are enhancing.
A commit that conflicts with your work when you made a trial merge of your work into next and seen for testing.

When you reference a commit on a more stable branch (like master, maint and next), use the format "abbreviated hash (subject, date)", like this:

        Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)
        noticed that ...

The "Copy commit reference" command of gitk can be used to obtain this format (with the subject enclosed in a pair of double-quotes), or this invocation of git show:

        git show -s --pretty=reference <commit>

or, on an older version of Git without support for --pretty=reference:

        git show -s --date=short --pretty='format:%h (%s, %ad)' <commit>

Certify your work by adding your `Signed-off-by` trailer

To improve tracking of who did what, we ask you to certify that you wrote the patch or have the right to pass it on under the same license as ours, by "signing off" your patch. Without sign-off, we cannot accept your patches.

If (and only if) you certify the below D-C-O:

Developer’s Certificate of Origin 1.1

By making a contribution to this project, I certify that:

The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

you add a "Signed-off-by" trailer to your commit, that looks like this:

        Signed-off-by: Random J Developer <random@developer.example.org>

This line can be added by Git if you run the git-commit command with the -s option.

Notice that you can place your own Signed-off-by trailer when forwarding somebody else’s patch with the above rules for D-C-O. Indeed you are encouraged to do so. Do not forget to place an in-body "From: " line at the beginning to properly attribute the change to its true author (see (2) above).

This procedure originally came from the Linux kernel project, so our rule is quite similar to theirs, but what exactly it means to sign-off your patch differs from project to project, so it may be different from that of the project you are accustomed to.

Also notice that a real name is used in the Signed-off-by trailer. Please don’t hide your real name.

If you like, you can put extra tags at the end:

Reported-by: is used to credit someone who found the bug that the patch attempts to fix.
Acked-by: says that the person who is more familiar with the area the patch attempts to modify liked the patch.
Reviewed-by:, unlike the other tags, can only be offered by the reviewers themselves when they are completely satisfied with the patch after a detailed analysis.
Tested-by: is used to indicate that the person applied the patch and found it to have the desired effect.
Co-authored-by: is used to indicate that people exchanged drafts of a patch before submitting it.
Helped-by: is used to credit someone who suggested ideas for changes without providing the precise changes in patch form.
Mentored-by: is used to credit someone with helping develop a patch as part of a mentorship program (e.g., GSoC or Outreachy).
Suggested-by: is used to credit someone with suggesting the idea for a patch.

While you can also create your own trailer if the situation warrants it, we encourage you to instead use one of the common trailers in this project highlighted above.

Only capitalize the very first letter of tags, i.e. favor "Signed-off-by" over "Signed-Off-By" and "Acked-by:" over "Acked-By".

Generate your patch using Git tools out of your commits.

Git based diff tools generate unidiff which is the preferred format.

You do not have to be afraid to use -M option to git diff or git format-patch, if your patch involves file renames. The receiving end can handle them just fine.

Please make sure your patch does not add commented out debugging code, or include any extra files which do not relate to what your patch is trying to achieve. Make sure to review your patch after generating it, to ensure accuracy. Before sending out, please make sure it cleanly applies to the starting point you have chosen in the "Choose a starting point" section.

Note	From the perspective of those reviewing your patch, the `master` branch is the default expected starting point. So if you have chosen a different starting point, please communicate this choice in your cover letter.

Sending your patches.

Before sending any patches, please note that patches that may be security relevant should be submitted privately to the Git Security mailing list
[The Git Security mailing list: git-security@googlegroups.com]
, instead of the public mailing list.

Learn to use format-patch and send-email if possible. These commands are optimized for the workflow of sending patches, avoiding many ways your existing e-mail client (often optimized for "multipart/*" MIME type e-mails) might render your patches unusable.

People on the Git mailing list need to be able to read and comment on the changes you are submitting. It is important for a developer to be able to "quote" your changes, using standard e-mail tools, so that they may comment on specific portions of your code. For this reason, each patch should be submitted "inline" in a separate message.

Multiple related patches should be grouped into their own e-mail thread to help readers find all parts of the series. To that end, send them as replies to either an additional "cover letter" message (see below), the first patch, or the respective preceding patch.

If your log message (including your name on the Signed-off-by trailer) is not writable in ASCII, make sure that you send off a message in the correct encoding.

Warning

Be wary of your MUAs word-wrap corrupting your patch. Do not cut-n-paste your patch; you can lose tabs that way if you are not careful.

It is a common convention to prefix your subject line with [PATCH]. This lets people easily distinguish patches from other e-mail discussions. Use of markers in addition to PATCH within the brackets to describe the nature of the patch is also encouraged. E.g. [RFC PATCH] (where RFC stands for "request for comments") is often used to indicate a patch needs further discussion before being accepted, [PATCH v2], [PATCH v3] etc. are often seen when you are sending an update to what you have previously sent.

The git format-patch command follows the best current practice to format the body of an e-mail message. At the beginning of the patch should come your commit message, ending with the Signed-off-by trailers, and a line that consists of three dashes, followed by the diffstat information and the patch itself. If you are forwarding a patch from somebody else, optionally, at the beginning of the e-mail message just before the commit message starts, you can put a "From: " line to name that person. To change the default "[PATCH]" in the subject to "[<text>]", use git format-patch --subject-prefix=<text>. As a shortcut, you can use --rfc instead of --subject-prefix="RFC PATCH", or -v <n> instead of --subject-prefix="PATCH v<n>".

You often want to add additional explanation about the patch, other than the commit message itself. Place such "cover letter" material between the three-dash line and the diffstat. For patches requiring multiple iterations of review and discussion, an explanation of changes between each iteration can be kept in Git-notes and inserted automatically following the three-dash line via git format-patch --notes.

Do not attach the patch as a MIME attachment, compressed or not. Do not let your e-mail client send quoted-printable. Do not let your e-mail client send format=flowed which would destroy whitespaces in your patches. Many popular e-mail applications will not always transmit a MIME attachment as plain text, making it impossible to comment on your code. A MIME attachment also takes a bit more time to process. This does not decrease the likelihood of your MIME-attached change being accepted, but it makes it more likely that it will be postponed.

Exception: If your mailer is mangling patches then someone may ask you to re-send them using MIME, that is OK.

Do not PGP sign your patch. Most likely, your maintainer or other people on the list would not have your PGP key and would not bother obtaining it anyway. Your patch is not judged by who you are; a good patch from an unknown origin has a far better chance of being accepted than a patch from a known, respected origin that is done poorly or does incorrect things.

If you really really really really want to do a PGP signed patch, format it as "multipart/signed", not a text/plain message that starts with -----BEGIN PGP SIGNED MESSAGE-----. That is not a text/plain, it’s something else.

As mentioned at the beginning of the section, patches that may be security relevant should not be submitted to the public mailing list mentioned below, but should instead be sent privately to the Git Security mailing list
[security-ml]
.

Send your patch with "To:" set to the mailing list, with "cc:" listing people who are involved in the area you are touching (the git contacts command in contrib/contacts/ can help to identify them), to solicit comments and reviews. Also, when you made trial merges of your topic to next and seen, you may have noticed work by others conflicting with your changes. There is a good possibility that these people may know the area you are touching well.

After the list reached a consensus that it is a good idea to apply the patch, re-send it with "To:" set to the maintainer
[The current maintainer: gitster@pobox.com]
and "cc:" the list
[The mailing list: git@vger.kernel.org]
for inclusion. This is especially relevant when the maintainer did not heavily participate in the discussion and instead left the review to trusted others.

Do not forget to add trailers such as Acked-by:, Reviewed-by: and Tested-by: lines as necessary to credit people who helped your patch, and "cc:" them when sending such a final version for inclusion.

Subsystems with dedicated maintainers

Some parts of the system have dedicated maintainers with their own repositories.

git-gui/ comes from git-gui project, maintained by Pratyush Yadav:
```
https://github.com/prati0100/git-gui.git
```

gitk-git/ comes from Paul Mackerras’s gitk project:

git://git.ozlabs.org/~paulus/gitk

Those who are interested in improving gitk can volunteer to help Paul
maintain it, cf. <YntxL/fTplFm8lr6@cleo>.

po/ comes from the localization coordinator, Jiang Xin:
```
https://github.com/git-l10n/git-po/
```

Patches to these parts should be based on their trees.

An ideal patch flow

Here is an ideal patch flow for this project the current maintainer suggests to the contributors:

You come up with an itch. You code it up.
Send it to the list and cc people who may need to know about the change.

The people who may need to know are the ones whose code you are butchering. These people happen to be the ones who are most likely to be knowledgeable enough to help you, but they have no obligation to help you (i.e. you ask for help, don’t demand). git log -p -- $area_you_are_modifying would help you find out who they are.
You get comments and suggestions for improvements. You may even get them in an "on top of your change" patch form.
Polish, refine, and re-send to the list and the people who spend their time to improve your patch. Go back to step (2).
The list forms consensus that the last round of your patch is good. Send it to the maintainer and cc the list.
A topic branch is created with the patch and is merged to next, and cooked further and eventually graduates to master.

In any time between the (2)-(3) cycle, the maintainer may pick it up from the list and queue it to seen, in order to make it easier for people to play with it without having to pick up and apply the patch to their trees themselves.

Know the status of your patch after submission

You can use Git itself to find out when your patch is merged in master. git pull --rebase will automatically skip already-applied patches, and will let you know. This works only if you rebase on top of the branch in which your patch has been merged (i.e. it will not tell you if your patch is merged in seen if you rebase on top of master).
Read the Git mailing list, the maintainer regularly posts messages entitled "What’s cooking in git.git" giving the status of various proposed changes.

GitHub CI

With an account at GitHub, you can use GitHub CI to test your changes on Linux, Mac and Windows. See https://github.com/git/git/actions/workflows/main.yml for examples of recent CI runs.

Follow these steps for the initial setup:

Fork https://github.com/git/git to your GitHub account. You can find detailed instructions how to fork here: https://help.github.com/articles/fork-a-repo/

After the initial setup, CI will run whenever you push new changes to your fork of Git on GitHub. You can monitor the test state of all your branches here: https://github.com/<Your GitHub handle>/git/actions/workflows/main.yml

If a branch does not pass all test cases then it will be marked with a red x, instead of a green check. In that case, you can click on the failing job and navigate to "ci/run-build-and-tests.sh" and/or "ci/print-test-failures.sh". You can also download "Artifacts" which are zip archives containing tarred (or zipped) archives with test data relevant for debugging.

Then fix the problem and push your fix to your GitHub fork. This will trigger a new CI build to ensure all tests pass.

MUA specific hints

Some of the patches I receive or pick up from the list share common patterns of breakage. Please make sure your MUA is set up properly not to corrupt whitespaces.

See the DISCUSSION section of git-format-patch(1) for hints on checking your patch by mailing it to yourself and applying with git-am(1).

While you are at it, check the resulting commit log message from a trial run of applying the patch. If what is in the resulting commit is not exactly what you would want to see, it is very likely that your maintainer would end up hand editing the log message when he applies your patch. Things like "Hi, this is my first patch.\n", if you really want to put in the patch e-mail, should come after the three-dash line that signals the end of the commit message.

Pine

(Johannes Schindelin)

I don't know how many people still use pine, but for those poor
souls it may be good to mention that the quell-flowed-text is
needed for recent versions.

... the "no-strip-whitespace-before-send" option, too. AFAIK it
was introduced in 4.60.

(Linus Torvalds)

And 4.58 needs at least this.

diff-tree 8326dd8350be64ac7fc805f6563a1d61ad10d32c (from e886a61f76edf5410573e92e38ce22974f9c40f1)
Author: Linus Torvalds <torvalds@g5.osdl.org>
Date:   Mon Aug 15 17:23:51 2005 -0700

    Fix pine whitespace-corruption bug

    There's no excuse for unconditionally removing whitespace from
    the pico buffers on close.

diff --git a/pico/pico.c b/pico/pico.c
--- a/pico/pico.c
+++ b/pico/pico.c
@@ -219,7 +219,9 @@ PICO *pm;
            switch(pico_all_done){      /* prepare for/handle final events */
              case COMP_EXIT :          /* already confirmed */
                packheader();
+#if 0
                stripwhitespace();
+#endif
                c |= COMP_EXIT;
                break;

(Daniel Barkalow)

> A patch to SubmittingPatches, MUA specific help section for
> users of Pine 4.63 would be very much appreciated.

Ah, it looks like a recent version changed the default behavior to do the
right thing, and inverted the sense of the configuration option. (Either
that or Gentoo did it.) So you need to set the
"no-strip-whitespace-before-send" option, unless the option you have is
"strip-whitespace-before-send", in which case you should avoid checking
it.

Thunderbird, KMail, GMail

See the MUA-SPECIFIC HINTS section of git-format-patch(1).

Gnus

"|" in the *Summary* buffer can be used to pipe the current message to an external program, and this is a handy way to drive git am. However, if the message is MIME encoded, what is piped into the program is the representation you see in your *Article* buffer after unwrapping MIME. This is often not what you would want for two reasons. It tends to screw up non-ASCII characters (most notably in people’s names), and also whitespaces (fatal in patches). Running "C-u g" to display the message in raw form before using "|" to run the pipe can work this problem around.