From owner-freebsd-git@freebsd.org Thu Jun 25 16:55:54 2020 Return-Path: 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 65C0A35F76C for ; Thu, 25 Jun 2020 16:55:54 +0000 (UTC) (envelope-from brooks@spindle.one-eyed-alien.net) Received: from spindle.one-eyed-alien.net (spindle.one-eyed-alien.net [199.48.129.229]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 49t5kK3KvJz4KWL; Thu, 25 Jun 2020 16:55:53 +0000 (UTC) (envelope-from brooks@spindle.one-eyed-alien.net) Received: by spindle.one-eyed-alien.net (Postfix, from userid 3001) id 382FA3C0199; Thu, 25 Jun 2020 16:55:47 +0000 (UTC) Date: Thu, 25 Jun 2020 16:55:47 +0000 From: Brooks Davis To: Ed Maste Cc: freebsd-git@freebsd.org Subject: Re: svn primer translation to git Message-ID: <20200625165547.GA75705@spindle.one-eyed-alien.net> References: MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="bp/iNruPH9dso1Pn" Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.9.4 (2018-02-28) X-Rspamd-Queue-Id: 49t5kK3KvJz4KWL X-Spamd-Bar: - Authentication-Results: mx1.freebsd.org; dkim=none; dmarc=none; spf=none (mx1.freebsd.org: domain of brooks@spindle.one-eyed-alien.net has no SPF policy when checking 199.48.129.229) smtp.mailfrom=brooks@spindle.one-eyed-alien.net X-Spamd-Result: default: False [-1.69 / 15.00]; ARC_NA(0.00)[]; FROM_HAS_DN(0.00)[]; TO_DN_SOME(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; NEURAL_HAM_LONG(-0.54)[-0.536]; MIME_GOOD(-0.20)[multipart/signed,text/plain]; DMARC_NA(0.00)[freebsd.org]; AUTH_NA(1.00)[]; NEURAL_SPAM_MEDIUM(0.02)[0.020]; NEURAL_HAM_SHORT(-0.27)[-0.271]; RCPT_COUNT_TWO(0.00)[2]; SIGNED_PGP(-2.00)[]; FORGED_SENDER(0.30)[brooks@freebsd.org,brooks@spindle.one-eyed-alien.net]; RCVD_COUNT_ZERO(0.00)[0]; R_SPF_NA(0.00)[no SPF record]; R_DKIM_NA(0.00)[]; MIME_TRACE(0.00)[0:+,1:+,2:~]; ASN(0.00)[asn:36236, ipnet:199.48.128.0/22, country:US]; FROM_NEQ_ENVFROM(0.00)[brooks@freebsd.org,brooks@spindle.one-eyed-alien.net] X-BeenThere: freebsd-git@freebsd.org X-Mailman-Version: 2.1.33 Precedence: list List-Id: Discussion of git use in the FreeBSD project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 25 Jun 2020 16:55:54 -0000 --bp/iNruPH9dso1Pn Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable 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/sub= version-primer.html >=20 > I've started a translation of this into a Git primer, at: > https://hackmd.io/ML5TSl8mQ5-27B5eqDf7YA?view >=20 > 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"`). -- Brooks --bp/iNruPH9dso1Pn Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQEcBAEBAgAGBQJe9NcNAAoJEKzQXbSebgfA4lgH/j2F2oKcbHVrhwbQKuqeDIM3 d9eVlbJVi1v2ZPnMO3+Wss8T2VUEDpODhL4st4FA7DHTzOS0bYg8b6u5Mw6npQg3 8DzmNUdSCCE5Ye2S+91qG/+arFa4gPrNs5EHAMvKHre6LsGqwP7/Za0w96VPArya 9aJPkW8xHn7Yo6snJw9PbaytHhY4AN5vHCuhAPAZOuW48z5rK7jQSQ+pZaLdSSZT vUkgUaSaKyVq+WSSeVkxyMuog+lXcUx75N88rNU8Can+pvDhrDJT4TKl4695VAEj W8R4eENxkmHxZwGcZfaIBSVZ4zr3fPJqE1vuHGNJKBjd/xanmcTH/c3vrWGvI3A= =zliX -----END PGP SIGNATURE----- --bp/iNruPH9dso1Pn--