svn primer translation to git

[Alexander Richardson]

On Thu, 25 Jun 2020 at 17:55, Brooks Davis <brooks at freebsd.org> wrote:
>
> On Wed, Jun 24, 2020 at 12:34:33PM -0400, Ed Maste wrote:
> > We currently have a FreeBSD Subversion primer in the committer's guide:
> > https://www.freebsd.org/doc/en_US.ISO8859-1/articles/committers-guide/subversion-primer.html
> >
> > I've started a translation of this into a Git primer, at:
> > https://hackmd.io/ML5TSl8mQ5-27B5eqDf7YA?view
> >
> > I'm particularly interested in feedback on how much git background /
> > theory of operation we want to include here (vs referring to external
> > documentation).
>
> One result of this being a translation of the SVN guide is that it's not
> IMO GIT-centric enough.  It suggests a number of things that are in
> fact excellent foot cannons (git commit -a being the most egregious).
> I'd like our document to recommend practices that make it relatively
> easy to double and triple check commits.  E.g. for direct commit I
> generally follow a process of staging with `git add -p` + `git add` for
> new files followed by `git status` and/or `git diff --staged`, and then
> `git commit`.
>
> Obviously people will have varying workflows, but for people with little
> git experience, let's try to prime them with good ones (unlike the
> quickstart tutorials that do things like `git commit -a -m "foo"`).

I know many people don't like using graphical tools for this, and
despite it not being a particularly nice UI, I find `git gui` to work
very well for checking that I don't accidentally commit something I
didn't mean to commit.
It also makes adding individual lines a lot easier than git add -p.
Recent versions of CLion also have a reasonably nice UI to avoid that problem.

Alex