Skip to content

[doc] Move most of the description of Git's workflow to the tech docs - #2244

Open
jvns wants to merge 1 commit into
gitgitgadget:masterfrom
jvns:workflow
Open

jvns wants to merge 1 commit into
gitgitgadget:masterfrom
jvns:workflow

Conversation

@jvns

@jvns jvns commented Sep 29, 2026 •

Copy link
Copy Markdown

I used the name WorkflowForGit following the style of ToolsForGit but it feels a bit awkward. Would welcome suggestions.

I tried to make as few changes as possible to the gitworkflows version of the document while still keeping it coherent and relevant to most Git users, but ultimately it was a lot of changes since most of the document is very specific to the Git project.

@gitgitgadget

gitgitgadget Bot commented Sep 29, 2026

Copy link
Copy Markdown

There is an issue in commit bea07f2:
[doc] Move most of the description of Git's workflow to the tech docs

  • Commit not signed off

@gitgitgadget

gitgitgadget Bot commented Sep 29, 2026

Copy link
Copy Markdown

There is an issue in commit 5927325:
[doc] Move most of the description of Git's workflow to the tech docs

  • Commit not signed off

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. Add a mention of
some kind of "main" or "master" branch, which almost every Git project
has, and use that branch to discuss merging.

Repoint references to `gitworkflows` to `WorkflowForGit` in the cases
that they're intended to reference the Git project's workflow, and also
reference it in `gitworkflows` in case folks want to read the original
document.

Signed-off-by: Julia Evans <julia@jvns.ca>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant