From patchwork Tue Oct 10 12:54:27 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Maxim Cournoyer X-Patchwork-Id: 54707 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 2FB1127BBEA; Tue, 10 Oct 2023 13:56:12 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_ADSP_CUSTOM_MED, DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FROM,MAILING_LIST_MULTI, SPF_HELO_PASS autolearn=ham autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 0A59527BBE9 for ; Tue, 10 Oct 2023 13:56:11 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qqCHE-0003zd-9X; Tue, 10 Oct 2023 08:55:56 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qqCH0-0003u3-84 for guix-patches@gnu.org; Tue, 10 Oct 2023 08:55:47 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qqCGz-0004uk-Pw for guix-patches@gnu.org; Tue, 10 Oct 2023 08:55:41 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qqCHK-0000I4-Md for guix-patches@gnu.org; Tue, 10 Oct 2023 08:56:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#66436] [PATCH] doc: Add some guidelines for reviewing. Resent-From: Maxim Cournoyer Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Tue, 10 Oct 2023 12:56:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 66436 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 66436@debbugs.gnu.org, maxim.cournoyer@gmail.com X-Debbugs-Original-To: guix-patches@gnu.org, maxim.cournoyer@gmail.com Received: via spool by submit@debbugs.gnu.org id=B.16969425161050 (code B ref -1); Tue, 10 Oct 2023 12:56:02 +0000 Received: (at submit) by debbugs.gnu.org; 10 Oct 2023 12:55:16 +0000 Received: from localhost ([127.0.0.1]:34247 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qqCGY-0000Gr-OH for submit@debbugs.gnu.org; Tue, 10 Oct 2023 08:55:15 -0400 Received: from lists.gnu.org ([2001:470:142::17]:51316) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qqCGU-0000Ga-EF for submit@debbugs.gnu.org; Tue, 10 Oct 2023 08:55:13 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qqCG3-0002yr-Hn for guix-patches@gnu.org; Tue, 10 Oct 2023 08:54:43 -0400 Received: from mail-qk1-x733.google.com ([2607:f8b0:4864:20::733]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qqCG1-0004Zf-NF for guix-patches@gnu.org; Tue, 10 Oct 2023 08:54:43 -0400 Received: by mail-qk1-x733.google.com with SMTP id af79cd13be357-77386822cfbso379469785a.0 for ; Tue, 10 Oct 2023 05:54:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1696942480; x=1697547280; darn=gnu.org; h=content-transfer-encoding:mime-version:message-id:date:subject:to :from:from:to:cc:subject:date:message-id:reply-to; bh=G8kBbFenunZSNMWvsvKTKp+fnxuuUp9i29bT2ST8UQQ=; b=OH2xUnuNvU3F+trJBcC7M38BXxkGVq3YmV6p53LnjarTrZT3MGBxBEob2TnZ5FRRwB Lq6VGijxZmTmnCGdADzcuSjaE7ot80vmgQB/12TV2c2/7Zy1cWAXDOsyIRvNsa4x9yC6 w969ckrMPsEgd6GZFnNNxS3gvXd/jWhWqLpLpfgBT34KCriiv2s6oKKYjA1DAzlDOFJJ mIzq1GnqvDaWj5IiNpDAhD2fo1GocM2ounM9vDGALczyUYW0Np073kBBH38lHvX+VMFr bh2/zTph0cQaTS5+gpSvtjhm4h5UxWkg9ynxi0AaORMvVNQwU+NDyegALdvrf32bGXOt Lt3Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1696942480; x=1697547280; h=content-transfer-encoding:mime-version:message-id:date:subject:to :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=G8kBbFenunZSNMWvsvKTKp+fnxuuUp9i29bT2ST8UQQ=; b=bZij2d7vDjf9TeiubijNFhfVkq80ipelHOv70E0Pjydu66QViBZhKbhhW0iSChBtv/ oCpX+mtS879dx57sR9zkNrg6p4GpG48UinXBoyJHvut63c+gmf6hg8/HytVKb4BoPTDA 2Nwr4F0MZHi8fdkcJTdaJeGL9a4oMhJi8g023Adk2iuibxQFMj05pwDsAI9YnFsw5G+a UmT4KikWtnJ0i41Z94GmYY0rQRGz9aVV0rvGnAw1sV1+va/gqbT2h0c4RrA8nw4IhVtB 6bJlSKEqw8SsTAgMT9RadWgTFjnAB2KFRTdhkXvKO8PIvbZWUX8VfHC9wBvbm5LplzAn NxhA== X-Gm-Message-State: AOJu0Yy5izQ8bH6Wlawu6jh7pLAieKxRJ4tf/sy8LgfDKhwzC0B+6dR8 ZI+iuynR0osADMIRREvtIy/SWu02nt+65A== X-Google-Smtp-Source: AGHT+IG3UtpGFBBsTc/bl4NKKkYzedVNl5OuQ1aCLkiS7ki1VMz7szPGkuKZ1qX2jE6UjucaBpaD6Q== X-Received: by 2002:a05:620a:4106:b0:774:2a7f:fa24 with SMTP id j6-20020a05620a410600b007742a7ffa24mr23197905qko.25.1696942480103; Tue, 10 Oct 2023 05:54:40 -0700 (PDT) Received: from localhost.localdomain (dsl-10-149-16.b2b2c.ca. [72.10.149.16]) by smtp.gmail.com with ESMTPSA id w19-20020a05620a149300b0076eee688a95sm4315688qkj.0.2023.10.10.05.54.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 10 Oct 2023 05:54:39 -0700 (PDT) From: Maxim Cournoyer Date: Tue, 10 Oct 2023 08:54:27 -0400 Message-ID: <19f82d9bbef649c750ad067d23ebbaee6f9ae494.1696942467.git.maxim.cournoyer@gmail.com> X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 Received-SPF: pass client-ip=2607:f8b0:4864:20::733; envelope-from=maxim.cournoyer@gmail.com; helo=mail-qk1-x733.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches * doc/contributing.texi (Contributing) [Reviewing the Work of Others]: New section. * doc/contributing.texi (Debbugs Usertags): Expound with Emacs Debbugs information and document the 'reviewed-looks-good' usertag. Change-Id: I56630b15ec4fbc5c67e5420dbf2838556a005d6b --- doc/contributing.texi | 53 +++++++++++++++++++++++++++++++++++++++---- 1 file changed, 48 insertions(+), 5 deletions(-) base-commit: 619ff2fa1d5b60b5fe33216ca2d6219c04a5515b diff --git a/doc/contributing.texi b/doc/contributing.texi index 864190b119..b09e9cc299 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -29,6 +29,7 @@ Contributing * Submitting Patches:: Share your work. * Tracking Bugs and Changes:: Keeping it all organized. * Commit Access:: Pushing to the official repository. +* Reviewing the Work of Others:: Some guidelines for sharing reviews. * Updating the Guix Package:: Updating the Guix package definition. * Writing Documentation:: Improving documentation in GNU Guix. * Translating Guix:: Make Guix speak your native language. @@ -605,7 +606,7 @@ Packaging Guidelines * Version Numbers:: When the name is not enough. * Synopses and Descriptions:: Helping users find the right package. * Snippets versus Phases:: Whether to use a snippet, or a build phase. -* Cyclic Module Dependencies:: Going full circle. +* Cyclic Module Dependencies:: Going full circle. * Emacs Packages:: Your Elisp fix. * Python Modules:: A touch of British comedy. * Perl Modules:: Little pearls. @@ -1972,7 +1973,12 @@ Debbugs Usertags tag any bug with an arbitrary label. Bugs can be searched by usertag, so this is a handy way to organize bugs@footnote{The list of usertags is public information, and anyone can modify any user's list of usertags, -so keep that in mind if you choose to use this feature.}. +so keep that in mind if you choose to use this feature.}. If you use +Emacs Debbugs, the entry-point to consult existing usertags is the +@samp{C-u M-x debbugs-gnu-usertags} procedure. To set a usertag, press +@samp{C} while consulting a bug within the *Guix-Patches* buffer opened +with @samp{C-u M-x debbugs-gnu-bugs} buffer, then select @code{usertag} +and follow the instructions. For example, to view all the bug reports (or patches, in the case of @code{guix-patches}) tagged with the usertag @code{powerpc64le-linux} @@ -1985,9 +1991,9 @@ Debbugs Usertags to interact with Debbugs. In Guix, we are experimenting with usertags to keep track of -architecture-specific issues. To facilitate collaboration, all our -usertags are associated with the single user @code{guix}. The following -usertags currently exist for that user: +architecture-specific issues, as well as reviewed ones. To facilitate +collaboration, all our usertags are associated with the single user +@code{guix}. The following usertags currently exist for that user: @table @code @@ -2005,6 +2011,9 @@ Debbugs Usertags appropriate to assign this usertag to a bug report for a package that fails to build reproducibly. +@item reviewed-looks-good +You have reviewed the series and it looks good to you (LGTM). + @end table If you're a committer and you want to add a usertag, just start using it @@ -2237,6 +2246,40 @@ Commit Access you're welcome to use your expertise and commit rights to help other contributors, too! +@node Reviewing the Work of Others +@section Reviewing the Work of Others + +Perhaps the biggest action you can do to help GNU Guix grow as a project +is to review the work contributed by others. You do not need to be a +committer to do so; applying, building, linting and running other +people's series and sharing your comments about your experience will +give some confidence to committers that should result in the proposed +change being merged faster. + +@cindex LGTM, Looks Good To Me +@cindex reviewing, guidelines +Review comments should be unambiguous; be as clear and explicit as you +can about what you think should be changed, ensuring the author can take +action on it. The following well understood/codified @acronym{LGTM, +Looks Good To Me} phrases should be used to sign off as a reviewer, +meaning you have reviewed the change and that it looks good to you: + +@enumerate +@item +If the @emph{whole} series (containing multiple commits) looks good to +you, reply with a @samp{This series LGTM!} to the cover page if it has +one, or to the last patch of the series otherwise. + +@item +If you instead want to mark a @emph{single commit} as reviewed (but not +the whole series), simply reply with @samp{LGTM!} to that commit +message. +@end enumerate + +If you are not a committer, you can help others find a @emph{series} you +have reviewed more easily by adding a @code{reviewed-looks-good} usertag +for the @code{guix} user (@pxref{Debbugs Usertags}). + @node Updating the Guix Package @section Updating the Guix Package