From: Seth Robertson <in-gitvger@baka.org>
To: git@vger.kernel.org
Subject: Announcing 3 git docs: Best Practices, fixing mistakes, post-production editing
Date: Tue, 28 Feb 2012 08:04:30 -0500	[thread overview]
Message-ID: <201202281304.q1SD4U8W018223@no.baka.org> (raw)
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             reply	other threads:[~2012-02-28 13:04 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-02-28 13:04 Seth Robertson [this message]
2012-02-28 22:52 ` Announcing 3 git docs: Best Practices, fixing mistakes, post-production editing Jeff King
2012-03-04 19:20   ` Seth Robertson
2012-02-29  1:00 ` Junio C Hamano
2012-03-04 19:20   ` Seth Robertson
2012-03-04 23:26     ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox
  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):
  git send-email \
    --in-reply-to=201202281304.q1SD4U8W018223@no.baka.org \
    --to=in-gitvger@baka.org \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY
  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
  Be sure your reply has a Subject: header at the top and a blank line
  before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).