From patchwork Sun Jun 13 10:15:35 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Ludovic_Court=C3=A8s?= X-Patchwork-Id: 30212 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id E2F2627BC81; Sun, 13 Jun 2021 11:16:21 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.9 required=5.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_MSPIKE_H4,RCVD_IN_MSPIKE_WL,SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 8853A27BC78 for ; Sun, 13 Jun 2021 11:16:21 +0100 (BST) Received: from localhost ([::1]:50098 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lsNAC-0001Gg-M3 for patchwork@mira.cbaines.net; Sun, 13 Jun 2021 06:16:20 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39652) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lsN9u-0000vJ-Nt for guix-patches@gnu.org; Sun, 13 Jun 2021 06:16:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:59382) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lsN9u-0002B5-GA for guix-patches@gnu.org; Sun, 13 Jun 2021 06:16:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lsN9u-0002jB-C0 for guix-patches@gnu.org; Sun, 13 Jun 2021 06:16:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#48696] [PATCH v2 1/4] doc: Structure the "Commit Access" section. Resent-From: Ludovic =?utf-8?q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sun, 13 Jun 2021 10:16:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 48696 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 48696@debbugs.gnu.org Cc: Ludovic =?utf-8?q?Court=C3=A8s?= Received: via spool by 48696-submit@debbugs.gnu.org id=B48696.16235793549959 (code B ref 48696); Sun, 13 Jun 2021 10:16:02 +0000 Received: (at 48696) by debbugs.gnu.org; 13 Jun 2021 10:15:54 +0000 Received: from localhost ([127.0.0.1]:42688 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lsN9l-0002Zy-Mr for submit@debbugs.gnu.org; Sun, 13 Jun 2021 06:15:54 -0400 Received: from eggs.gnu.org ([209.51.188.92]:41848) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lsN9i-0002Ri-FI for 48696@debbugs.gnu.org; Sun, 13 Jun 2021 06:15:51 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:38710) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lsN9c-0001um-UI; Sun, 13 Jun 2021 06:15:44 -0400 Received: from [2a01:e0a:1d:7270:af76:b9b:ca24:c465] (port=55286 helo=gnu.org) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lsN9c-0002w0-Mj; Sun, 13 Jun 2021 06:15:44 -0400 From: Ludovic =?utf-8?q?Court=C3=A8s?= Date: Sun, 13 Jun 2021 12:15:35 +0200 Message-Id: <20210613101538.10668-2-ludo@gnu.org> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20210613101538.10668-1-ludo@gnu.org> References: <87lf7g7azx.fsf@gnu.org> <20210613101538.10668-1-ludo@gnu.org> MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" X-getmail-retrieved-from-mailbox: Patches * doc/contributing.texi (Commit Access): Add introduction and section heading. Separate OpenPGP setup from commit policy. --- doc/contributing.texi | 59 ++++++++++++++++++++++++++++--------------- 1 file changed, 38 insertions(+), 21 deletions(-) diff --git a/doc/contributing.texi b/doc/contributing.texi index d67e632520..4ab489173b 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -1275,8 +1275,19 @@ this nifty tool! @section Commit Access @cindex commit access, for developers -For frequent contributors, having write access to the repository is -convenient. When you deem it necessary, consider applying for commit +Everyone can contribute to Guix without having commit access +(@pxref{Submitting Patches}). However, for frequent contributors, +having write access to the repository can be convenient. Commit access +should not be thought of as a ``badge of honor'' but rather as a +responsibility a contributor is willing to take to help the project. + +The following sections explain how to get commit access, how to be ready +to push commits, and the policies and community expectations for commits +pushed upstream. + +@subsection Applying for Commit Access + +When you deem it necessary, consider applying for commit access by following these steps: @enumerate @@ -1348,6 +1359,27 @@ review and merging system, which, as a consequence, may lead us to have fewer people with commit access to the main repository. Stay tuned! @end quotation +All commits that are pushed to the central repository on Savannah must +be signed with an OpenPGP key, and the public key should be uploaded to +your user account on Savannah and to public key servers, such as +@code{keys.openpgp.org}. To configure Git to automatically sign +commits, run: + +@example +git config commit.gpgsign true +git config user.signingkey CABBA6EA1DC0FF33 +@end example + +You can prevent yourself from accidentally pushing unsigned commits to +Savannah by using the pre-push Git hook called located at +@file{etc/git/pre-push}: + +@example +cp etc/git/pre-push .git/hooks/pre-push +@end example + +@subsection Commit Policy + If you get commit access, please make sure to follow the policy below (discussions of the policy can take place on @email{guix-devel@@gnu.org}). @@ -1366,25 +1398,6 @@ mailing list for commit notifications (@email{guix-commits@@gnu.org}), so people can notice. Before pushing your changes, make sure to run @code{git pull --rebase}. -All commits that are pushed to the central repository on Savannah must -be signed with an OpenPGP key, and the public key should be uploaded to -your user account on Savannah and to public key servers, such as -@code{keys.openpgp.org}. To configure Git to automatically sign -commits, run: - -@example -git config commit.gpgsign true -git config user.signingkey CABBA6EA1DC0FF33 -@end example - -You can prevent yourself from accidentally pushing unsigned commits to -Savannah by using the pre-push Git hook called located at -@file{etc/git/pre-push}: - -@example -cp etc/git/pre-push .git/hooks/pre-push -@end example - When pushing a commit on behalf of somebody else, please add a @code{Signed-off-by} line at the end of the commit log message---e.g., with @command{git am --signoff}. This improves tracking of who did @@ -1406,12 +1419,16 @@ you're confident, it's OK to commit. That last part is subject to being adjusted, allowing individuals to commit directly on non-controversial changes on parts they’re familiar with. +@subsection Commit Revocation + In order to reduce the possibility of mistakes, committers will have their Savannah account removed from the Guix Savannah project and their key removed from @file{.guix-authorizations} after 12 months of inactivity; they can ask to regain commit access by emailing the maintainers, without going through the vouching process. +@subsection Helping Out + One last thing: the project keeps moving forward because committers not only push their own awesome changes, but also offer some of their time @emph{reviewing} and pushing other people's changes. As a committer,