git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Announcing 3 git docs: Best Practices, fixing mistakes, post-production editing

From
SRSeth Robertson <in-gitvger@baka.org>
Date
Feb 28, 2012, 13:04 UTC
Message-ID
<201202281304.q1SD4U8W018223@no.baka.org>

I would like to announce three git documents I have written which others (primarily on #git) have thought to be very useful, and so I would like to share them with the wider community.

Commit Often, Perfect Later, Publish Once: Git Best Practices ---------------------------------------------------------------------- http://sethrobertson.github.com/GitBestPractices

This first document covers a variety of topics, providing references and recommendations for using git. These best practices have been built up through decades of professional software management and development, years of git usage, and countless hours helping people on #git.

Table of Contents:

Do read about git On Sausage Making Do commit early and often Do keep up to date Don't panic Do periodic maintenance Do backups Do enforce Standards Don't change published history Do use useful tools Do choose a workflow Do integrate with external tools Do divide work into repositories Miscellaneous "Do"s Do make useful commit messages Miscellaneous "Don't"s

On undoing, fixing, or removing commits or mistakes in git ---------------------------------------------------------------------- http://sethrobertson.github.com/GitFixUm

This next document covers the process of recovering from mistakes made either while or when using git. It is a choose-your-own-adventure(1) style document which asks a series of questions to try and understand exactly what you did and what you want to do. Currently it provides twenty different solutions to various problems I have seen people have. This was primarily developed to stop answering the same questions over and over again in #git, and worse, providing the wrong answers when questioners either failed to provide critical information or totally misunderstood what was going on.

Post-Production Editing using Git ---------------------------------------------------------------------- http://sethrobertson.github.com/GitPostProduction

This most recent document covers the topic of how to use git to make your commits appear like they were made perfectly to the outside world. Doing so is something which is required by some projects, is recommended in gitworkflows(7) and the best practices document (On Sausage Making), and is a major feature of git. However, I have not found good documentation on exactly how to use git to accomplish this. The git-rebase man page is quite extensive, but also fairly confusing to the uninitiated.

I would appreciate comments, suggestions, or contributions for all three documents.

                                        -Seth Robertson

(1) Not affiliated with Chooseco, LLC's "Choose Your Own Adventure"ⓡ. Good books, but a little light on the details of recovering from git merge errors.

Next: Jeff King
Message 1 of 6 in “Announcing 3 git docs: Best Practices, fixing mistakes, post-production editing”
  1. Seth RobertsonFeb 28, 2012
  2. Jeff KingFeb 28, 2012
  3. Seth RobertsonMar 4, 2012
  4. Junio C HamanoFeb 29, 2012
  5. Seth RobertsonMar 4, 2012
  6. Junio C HamanoMar 4, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.