From patchwork Thu May 27 12:35:53 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: 29623 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 B422B27BC81; Thu, 27 May 2021 14:31:47 +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=-5.2 required=5.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_MED,RCVD_IN_MSPIKE_H4,RCVD_IN_MSPIKE_WL,SPF_HELO_PASS 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 81F1E27BC78 for ; Thu, 27 May 2021 14:31:47 +0100 (BST) Received: from localhost ([::1]:47316 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lmG70-0000Jc-OG for patchwork@mira.cbaines.net; Thu, 27 May 2021 09:31:46 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:32992) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lmFG5-0006X5-P1 for guix-patches@gnu.org; Thu, 27 May 2021 08:37:10 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:39302) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lmFG2-0006w4-O2 for guix-patches@gnu.org; Thu, 27 May 2021 08:37:04 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lmFG2-0006DL-Ln for guix-patches@gnu.org; Thu, 27 May 2021 08:37:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#48696] [PATCH 2/3] doc: Add "Addressing Mistakes" section. Resent-From: Ludovic =?utf-8?q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Thu, 27 May 2021 12:37: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.162211898023814 (code B ref 48696); Thu, 27 May 2021 12:37:02 +0000 Received: (at 48696) by debbugs.gnu.org; 27 May 2021 12:36:20 +0000 Received: from localhost ([127.0.0.1]:50844 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lmFFL-0006C1-Ns for submit@debbugs.gnu.org; Thu, 27 May 2021 08:36:19 -0400 Received: from eggs.gnu.org ([209.51.188.92]:39132) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lmFFJ-0006Bc-N7 for 48696@debbugs.gnu.org; Thu, 27 May 2021 08:36:17 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:42908) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lmFFB-0006Tc-EU; Thu, 27 May 2021 08:36:10 -0400 Received: from [2a01:e0a:1d:7270:af76:b9b:ca24:c465] (port=40496 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 1lmFF7-0005Bm-Tw; Thu, 27 May 2021 08:36:07 -0400 From: Ludovic =?utf-8?q?Court=C3=A8s?= Date: Thu, 27 May 2021 14:35:53 +0200 Message-Id: <20210527123554.4267-2-ludo@gnu.org> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210527123554.4267-1-ludo@gnu.org> References: <20210527123554.4267-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 (Addressing Mistakes): New section. --- doc/contributing.texi | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/doc/contributing.texi b/doc/contributing.texi index 7dc912b4de..8308551261 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -1402,6 +1402,40 @@ 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 Addressing Mistakes + +We all make mistakes. We expect peer review (@pxref{Submitting +Patches}) and tools such as @command{guix lint} (@pxref{Invoking guix +lint}) and the test suite (@pxref{Running the Test Suite}) to catch +issues before they are pushed; yet, mistakes might go through---that +happens to both newcomers and old-timers, and there is nothing to be +ashamed of when it happens. As a community, we expect committers to +recognize and address mistakes as soon as possible. + +Some mistakes can directly affect all users---for instance because they +make @command{guix pull} fail or break core functionality, because they +break major packages (at build time or run time), or because they +introduce known security vulnerabilities. + +@cindex reverting commits +The person who pushed the faulty commit(s) should be at the forefront to +address such an issue in a timely fashion: by pushing a followup commit +to fix it (if possible), or by reverting it to leave time to come up +with a proper fix, and by communicating with other developers about the +problem. + +If the committer is unavailable to address the issue in time, other +committers are entitled to revert the offending commit(s), explaining in +the commit log and on the mailing list what the problem was, with the +goal of leaving time to the original committer and author(s) to propose +a way forward. + +The Guix project values friendly cooperation and a constant effort to +focus on the way forward when issues arise. Committers should lead by +example, notably as a way to encourage contributors and contributors to +be. Blame as well as defensiveness do not have their place in Guix when +addressing genuine mistakes. + @subsection Commit Revocation In order to reduce the possibility of mistakes, committers will have