From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 73537139694 for ; Tue, 25 Jul 2017 12:28:28 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 0B4191FC052; Tue, 25 Jul 2017 12:28:24 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id B37BF1FC007 for ; Tue, 25 Jul 2017 12:28:23 +0000 (UTC) Received: from [IPv6:2001:44b8:4197:2800:a37a:5ec1:db17:1e49] (2001-44b8-4197-2800-a37a-5ec1-db17-1e49.static.ipv6.internode.on.net [IPv6:2001:44b8:4197:2800:a37a:5ec1:db17:1e49]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: kensington) by smtp.gentoo.org (Postfix) with ESMTPSA id 0884234172F for ; Tue, 25 Jul 2017 12:28:21 +0000 (UTC) Subject: [gentoo-dev] Re: [RFC pre-GLEP] Gentoo Git Workflow References: <1500969906.1206.1.camel@gentoo.org> To: gentoo-dev@lists.gentoo.org From: Michael Palimaka Message-ID: <2caadc57-87da-67fd-6824-8fbeb3e1ddc9@gentoo.org> Date: Tue, 25 Jul 2017 22:28:16 +1000 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.2.0 Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@lists.gentoo.org Reply-to: gentoo-dev@lists.gentoo.org MIME-Version: 1.0 In-Reply-To: <1500969906.1206.1.camel@gentoo.org> Content-Type: text/plain; charset=utf-8 Content-Language: en-GB Content-Transfer-Encoding: 8bit X-Archives-Salt: cc4b116e-737a-4b9c-abd0-7ffcccee3e34 X-Archives-Hash: 8b30036e27bae70db25a45eb20d03152 On 07/25/2017 06:05 PM, Michał Górny wrote: > Hi, everyone. > > There have been multiple attempts at grasping this but none so far > resulted in something official and indisputable. At the same time, we > end having to point our users at semi-official guides which change > in unpredictable ways. > > Here's the current draft: > https://wiki.gentoo.org/wiki/User:MGorny/GLEP:Git This looks really nice, thanks for working on it. > * When doing a minor change to a large number of packages, it is > reasonable to do so in a single commit. However, when doing a major > change (e.g. a version bump), it is better to split commits on package > boundaries. In some cases we do prefer to make major changes on a set of related package all in one commit. For example, we always bump the 240+ KDE Applications collection together because that's how it's released. > ===Commit messages=== > A standard git commit message consists of three parts, in order: a > summary line, an optional body and an optional set of tags. The parts > are separated by a single empty line. > > The summary line is included in the short logs (git log -- > oneline, gitweb, GitHub, mail subject) and therefore should > provide a short yet accurate description of the change. The summary line > starts with a logical unit name, followed by a colon, a space and a > short description of the most important changes. If a bug is associated > with a change, then it should be included in the summary line as > #nnnnnn or likewise. The summary line must not exceed 69 > characters, and must not be wrapped. Does a bug # really need to always be in the summary line? It can eat valuable characters and tags which are pretty popular are equally valid IMO. > ** Bug: https://bugs.gentoo.org/NNNNNN; — to > reference a bug, > ** Closes: https://github.com/gentoo/gentoo/pull/NNNN ki>; — to automatically close a GitHub pull request, > ** Fixes: https://bugs.gentoo.org/NNNNNN; — > to indicate a fixed bug, grepping the git log shows that 'Gentoo-bug' is much more common than plain 'Bug'. 'Fixes' is hardly used at all, and I think it's a bit confusing to use this for bugs as well as commits. > a few branches on the repository, and did not maintain them. The Infra > had to query the developers about the state of the branches and clean > them up. Should 'The Infra' be 'The Infra team' or just 'Infra'? > Gentoo developers are still frequently using Gentoo-Bug tag, > sometimes followed by Gentoo-Bug-URL. Using both > simultaneously is meaningless (they are redundant), and using the former > has no advantages over using the classic #nnnnnn form in the > summary or the body. I agree that using both is redundant, but I don't agree with discouraging or banning the use of 'Gentoo-bug'. If someone prefers to use it so it sits nicely with the other tags why stop them?