From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:403:478a::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms8.migadu.com with LMTPS id OJo4LNjoN2WQhgAA9RJhRA:P1 (envelope-from ) for ; Tue, 24 Oct 2023 17:55:04 +0200 Received: from aspmx1.migadu.com ([2001:41d0:403:478a::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id OJo4LNjoN2WQhgAA9RJhRA (envelope-from ) for ; Tue, 24 Oct 2023 17:55:04 +0200 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 94CEA601F9 for ; Tue, 24 Oct 2023 17:55:04 +0200 (CEST) Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gnu.org header.s=fencepost-gnu-org header.b=UT2cB5VV; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=gnu.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1698162904; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:resent-cc: resent-from:resent-sender:resent-message-id:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=HAKdRPaX35x2KDVE0xnwaq0WXhyZ2FE/OS7Vfy5PEwY=; b=oRHH6nvxL6mYDLE65vsRPPSb2hyvulYowZ7vUzQR2iivQk8aP5o6fA78wZeMIGu9HHvTL4 V2bEFwf9n5QSiN53mww8QdgVQMrfpwz/CAn53/SYLEXAUvIodx13zhKOAf2LgknXY1yFu6 +BgC4is3dD6dSzZYZTlvLqkAgzozBTzDmBzleC5yDSBxGhKEQssSMD/6S/MrhfuFPhi6TC wrSV7k8ky9bivmo9G3/6T0IPaRX1lY+tc3nhSw2POnFJWSediMUmPtBNl53OXyBG0rAlvO JViIibKT7C4YqDNtm6yDDuyFpsk43jZGVUbn3CJc5ineN3v/slQL1EPu7H0ypA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1698162904; a=rsa-sha256; cv=none; b=obB0Yz3PHOBQKfCX37JXEu+pwuHy7fcH75mBhtrRVTDqeBEzjaolr8t0WohaxpxyoFUi1Q Mvqg5z7UVwgovB6acrVPwkS+LQde8pGOG95m4Byoi3/LQ7Z65cBCK15c3SahmODEBbGvZA FQYl+oa4UGfcWdw3EJBNXeMqvCWZzsPkw1HjkUQgKwEwOpi7OXawNgFqIpwxfzVaGOEBno lYc+/5wgJm6UVQTQAvgeTsAhPiDGIk1R3iyEBVHD0Waebiqn5JoaUPHvauDtQi0z1ZdLsV B+qVdTygLOa5Le1jV0Zb6+kBdFnRgGTIlM2biQLuWKiRF43DfJPTXYulO/qXgg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gnu.org header.s=fencepost-gnu-org header.b=UT2cB5VV; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=gnu.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qvJk4-0005wP-I7; Tue, 24 Oct 2023 11:54:52 -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 1qvJjy-0005uM-Hp for guix-patches@gnu.org; Tue, 24 Oct 2023 11:54: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 1qvJjk-00026r-G2 for guix-patches@gnu.org; Tue, 24 Oct 2023 11:54:42 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qvJkD-0004Tl-UQ for guix-patches@gnu.org; Tue, 24 Oct 2023 11:55:01 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#66436] [PATCH v2] doc: Add some guidelines for reviewing. Resent-From: Ludovic =?UTF-8?Q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Tue, 24 Oct 2023 15:55:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66436 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Maxim Cournoyer Cc: 66436@debbugs.gnu.org Received: via spool by 66436-submit@debbugs.gnu.org id=B66436.169816289317195 (code B ref 66436); Tue, 24 Oct 2023 15:55:01 +0000 Received: (at 66436) by debbugs.gnu.org; 24 Oct 2023 15:54:53 +0000 Received: from localhost ([127.0.0.1]:56384 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qvJk5-0004TG-FI for submit@debbugs.gnu.org; Tue, 24 Oct 2023 11:54:53 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:44622) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qvJk1-0004Sx-2H for 66436@debbugs.gnu.org; Tue, 24 Oct 2023 11:54:52 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qvJjR-00023q-Q2; Tue, 24 Oct 2023 11:54:13 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:Date:References:In-Reply-To:Subject:To: From; bh=HAKdRPaX35x2KDVE0xnwaq0WXhyZ2FE/OS7Vfy5PEwY=; b=UT2cB5VVPXCbdr679Q4y rTpmM36OQIVkKgMHipIYKp9HFMlA7M87dJXQqrbOFn/i2dbdAVpJYiGA4bwdJlMjU4J5XRQUZXvNB iKoLYirViG5Ad4+lOxbp6gjhEum5gtcu/CtP316UguRPjIxRyvm1/tn/tmWAKVRzBxJW5qpMdPzWi d6oq0erWiqKyXhe1+lJLyhFFB11a07oM3KIfYIhzpwRNoTKeYmsApSP88+cnRecJUek8LYqR23peU bTHv2emvkjFNssOchNJjdNfFpYS/bUUS4sNQdqypbCIsldM7DXAfKzIp1odWezfW7KRlc7i1dsdrd 49bLXdRTdf9Ewg==; From: Ludovic =?UTF-8?Q?Court=C3=A8s?= In-Reply-To: <0a5e027af3c0b61f9ab9f3c66e73b7a769eef7fd.1696983695.git.maxim.cournoyer@gmail.com> (Maxim Cournoyer's message of "Tue, 10 Oct 2023 20:24:05 -0400") References: <19f82d9bbef649c750ad067d23ebbaee6f9ae494.1696942467.git.maxim.cournoyer@gmail.com> <0a5e027af3c0b61f9ab9f3c66e73b7a769eef7fd.1696983695.git.maxim.cournoyer@gmail.com> Date: Tue, 24 Oct 2023 17:54:11 +0200 Message-ID: <87a5s86mos.fsf@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable 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+larch=yhetil.org@gnu.org Sender: guix-patches-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Spam-Score: -4.10 X-Migadu-Queue-Id: 94CEA601F9 X-Migadu-Scanner: mx0.migadu.com X-Migadu-Spam-Score: -4.10 X-TUID: yojzaN5xcFHm Hi, Maxim Cournoyer skribis: > * doc/contributing.texi (Contributing) [Reviewing the Work of Others]: New > section. > * doc/contributing.texi (Debbugs Usertags): Expound with Emacs Debbugs ^ Nitpick: no need to repeat the file name. > +@node Reviewing the Work of Others > +@section Reviewing the Work of Others [...] > +@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. Please try to keep the following guidelines in mind > +during review: [...] > +@item > +@emph{Remain focused: do not change the scope of the work being > +reviewed.} For example, if the contribution touches code that follows a > +pattern deemed unwieldy, it would be unfair to ask the submitter to fix > +all occurrences of that pattern in the code; to put it simply, if a > +problem unrelated to the patch at hand was already there, do not ask the > +submitter to fix it. Another item came to mind, that could be phrased like this: Spend time proportional to the stakes. Ensure the discussion focuses on important aspects of the changes; do not let it be derailed by objectively unimportant issues@footnote{This situation is often referred to as ``bikeshedding'', where much time is spent discussing each one's preference for the color of the shed at the expense progress made on the project to keep bikes dry.}. In particular, issues such as code formatting and other conventions can be dealt with through automation---e.g., @command{guix lint} and @command{guix style}---or through documentation (@pxref{Packaging Guidelines}, as an example). Maybe that makes the guidelines too long though; your call. Otherwise LGTM! Ludo=E2=80=99.