Skip to content

Commit c8c2b1d

Browse files
jvnsjvns
committed
[doc] Move most of the description of Git's workflow to the tech docs
Almost all Git users use Git in an extremely different way than the Git project does, so we should not use the Git project's workflow as an example of a workflow to follow. Move the contents of gitworkflows to a new tech doc called `WorkflowForGit.adoc`, since its contents are useful to contributors to the Git project. Leave the parts of `gitworkflows` which are applicable to projects more broadly: small commits, topic branches, and merging. Repoint references to `gitworkflows` to `WorkflowForGit` in the cases that they're intended to reference the Git project's workflow. Signed-off-by: Julia Evans <julia@jvns.ca>
1 parent a018953 commit c8c2b1d

6 files changed

Lines changed: 489 additions & 412 deletions

File tree

‎Documentation/Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ SP_ARTICLES += $(API_DOCS)
113113

114114
TECH_DOCS += BreakingChanges
115115
TECH_DOCS += DecisionMaking
116+
TECH_DOCS += WorkflowForGit
116117
TECH_DOCS += ReviewingGuidelines
117118
TECH_DOCS += MyFirstContribution
118119
TECH_DOCS += MyFirstObjectWalk

‎Documentation/SubmittingPatches‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,8 @@ speaking it is actually a particular commit (typically the HEAD, or tip,
150150
of the branch).
151151

152152
There are several important branches to be aware of. Namely, there are
153-
four integration branches as discussed in linkgit:gitworkflows[7]:
153+
four integration branches as discussed in
154+
link:WorkflowForGit.html[WorkflowForGit]:
154155

155156
* maint
156157
* master
@@ -173,7 +174,8 @@ parent of this commit is the tip of the topic branch.
173174
There is one guiding principle for choosing the right starting point: in
174175
general, always base your work on the oldest integration branch that
175176
your change is relevant to (see "Merge upwards" in
176-
linkgit:gitworkflows[7]). What this principle means is that for the
177+
link:WorkflowForGit.html[WorkflowForGit]).
178+
What this principle means is that for the
177179
vast majority of cases, the starting point for new work should be the
178180
latest HEAD commit of `maint` or `master` based on the following cases:
179181

0 commit comments

Comments
 (0)