From owner-freebsd-git@freebsd.org  Thu Jun 25 06:24:58 2020
Return-Path: <owner-freebsd-git@freebsd.org>
Delivered-To: freebsd-git@mailman.nyi.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1])
 by mailman.nyi.freebsd.org (Postfix) with ESMTP id 94B2C352D15
 for <freebsd-git@mailman.nyi.freebsd.org>;
 Thu, 25 Jun 2020 06:24:58 +0000 (UTC)
 (envelope-from ehaupt@FreeBSD.org)
Received: from smtp.freebsd.org (smtp.freebsd.org
 [IPv6:2610:1c1:1:606c::24b:4])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256
 client-signature RSA-PSS (4096 bits) client-digest SHA256)
 (Client CN "smtp.freebsd.org",
 Issuer "Let's Encrypt Authority X3" (verified OK))
 by mx1.freebsd.org (Postfix) with ESMTPS id 49sqkL3R4zz4fm2;
 Thu, 25 Jun 2020 06:24:58 +0000 (UTC)
 (envelope-from ehaupt@FreeBSD.org)
Received: from beaver (unknown [IPv6:2a02:169:175:0:12bf:48ff:fee1:88e])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate) (Authenticated sender: ehaupt)
 by smtp.freebsd.org (Postfix) with ESMTPSA id E93DD2868F;
 Thu, 25 Jun 2020 06:24:57 +0000 (UTC)
 (envelope-from ehaupt@FreeBSD.org)
Date: Thu, 25 Jun 2020 08:24:55 +0200
From: Emanuel Haupt <ehaupt@FreeBSD.org>
To: Ed Maste <emaste@freebsd.org>
Cc: freebsd-git@freebsd.org
Subject: Re: svn primer translation to git
Message-Id: <20200625082455.9f1343f6f353f4be24385bc6@FreeBSD.org>
In-Reply-To: <CAPyFy2Dy4cLQpgUsk_ushXsQFvRPk2S8SEfgWF=0xibGRGJvKw@mail.gmail.com>
References: <CAPyFy2Dy4cLQpgUsk_ushXsQFvRPk2S8SEfgWF=0xibGRGJvKw@mail.gmail.com>
X-Mailer: Sylpheed 3.7.0 (GTK+ 2.24.32; amd64-portbld-freebsd12.0)
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
X-BeenThere: freebsd-git@freebsd.org
X-Mailman-Version: 2.1.33
Precedence: list
List-Id: Discussion of git use in the FreeBSD project <freebsd-git.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/freebsd-git>,
 <mailto:freebsd-git-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-git/>
List-Post: <mailto:freebsd-git@freebsd.org>
List-Help: <mailto:freebsd-git-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/freebsd-git>,
 <mailto:freebsd-git-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Thu, 25 Jun 2020 06:24:58 -0000

Ed Maste <emaste@freebsd.org> 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).

Thank you for writing the document.

Maybe we could address the convention [1] that with git commit messages
usually begin with a subject, followed by a blank line and then the
commit body.

This schema produces beautiful commit logs on web-based DevOps lifecycle
tools such as github, gitlab, gitea.

I further recommend this [2] article on the subject.

Emanuel

[1] https://git-scm.com/docs/git-commit#_discussion
[2] https://chris.beams.io/posts/git-commit/