From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:306:2d92::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms8.migadu.com with LMTPS id OCUJAyIHM2VTVQEAauVa8A:P1 (envelope-from ) for ; Sat, 21 Oct 2023 01:02:58 +0200 Received: from aspmx1.migadu.com ([2001:41d0:306:2d92::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id OCUJAyIHM2VTVQEAauVa8A (envelope-from ) for ; Sat, 21 Oct 2023 01:02:58 +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 ACC0D5E747 for ; Sat, 21 Oct 2023 01:02:57 +0200 (CEST) Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20230601 header.b=LIRkFgxA; 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=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none) ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1697842977; 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=Ml7q1FSw0rL1lYADaL4/tkxbt6LgDYPTklZzqqstLMk=; b=oBMTMPxXBkj4e4WvQLW84ERNO9TNDq0L/l9eaIaoBU/a98g3MFbjiEOf3rbjUVXicVZHx8 aGwBm4Gpx5m5gSabmj9CNt+0oUiv2sFK/WxADnNCDDfZp7v2MBpLxDiSx57GviRx8zDgAb sSS9GsW/AVNo7q44QepCiQ475TYT4ot+PPRJBfCsiGkAXjuPJlBMDpYAZhqotTOgpRXDhj qNIMAZ4d8UhudU2pTDwEbvXsnv0wWrIQBGp1Hp58YqzwTGLmx5P9IIgtNZrhR9E6yHm1oS kYkikbeYhl2r5cYEgBoCRg0kRn2/w4bD8XNQgurKLeGM4dFzUThHFIBav3/MlQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20230601 header.b=LIRkFgxA; 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=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none) ARC-Seal: i=1; s=key1; d=yhetil.org; t=1697842977; a=rsa-sha256; cv=none; b=ukTB2BBaTTAC0DH9aF1kpKcD3mmVjzDK9YAGESqxNPBPb4JqZ79c/KI1IZc/lM1te2sIVW ylX5OS49SyTT1QyMbdVrALSE0NaBsY7GdL92hX3cTKpQSWaGVygq7w8PrigQVoBaby1b5u qzeluPQi4Gmz6vkJY2QuTi587vVKGWjZXogDj1/yqelJ4oF57IcyibJCflk9DnnfZQc8nb 5S2iGvLZXt/AAc3a4Yhf88cepljfHYARUqE53/DOD678HzrmV1S3lP/iiRPr8gPTFOapBo rSzW5CxgtzjqnCc2fbV9fIcprl76cjhKNtd2OLJu1HQMfkLaMmrjyfG+QhiZBg== Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qtyVo-0008ID-J1; Fri, 20 Oct 2023 19:02:36 -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 1qtyVn-0008Hw-Eh for guix-patches@gnu.org; Fri, 20 Oct 2023 19:02:35 -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 1qtyVn-0000Tn-6X for guix-patches@gnu.org; Fri, 20 Oct 2023 19:02:35 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qtyWE-000478-BQ for guix-patches@gnu.org; Fri, 20 Oct 2023 19:03:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#66436] [PATCH v2] doc: Add some guidelines for reviewing. Resent-From: Maxim Cournoyer Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Fri, 20 Oct 2023 23:03:02 +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: =?UTF-8?Q?Cl=C3=A9ment?= Lassieur Cc: 66436@debbugs.gnu.org, Ludovic =?UTF-8?Q?Court=C3=A8s?= Received: via spool by 66436-submit@debbugs.gnu.org id=B66436.169784294715764 (code B ref 66436); Fri, 20 Oct 2023 23:03:02 +0000 Received: (at 66436) by debbugs.gnu.org; 20 Oct 2023 23:02:27 +0000 Received: from localhost ([127.0.0.1]:41862 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qtyVb-000468-8m for submit@debbugs.gnu.org; Fri, 20 Oct 2023 19:02:27 -0400 Received: from mail-oo1-xc34.google.com ([2607:f8b0:4864:20::c34]:52728) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qtyVU-00045m-BE for 66436@debbugs.gnu.org; Fri, 20 Oct 2023 19:02:21 -0400 Received: by mail-oo1-xc34.google.com with SMTP id 006d021491bc7-581cb88f645so771583eaf.1 for <66436@debbugs.gnu.org>; Fri, 20 Oct 2023 16:01:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1697842903; x=1698447703; darn=debbugs.gnu.org; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Ml7q1FSw0rL1lYADaL4/tkxbt6LgDYPTklZzqqstLMk=; b=LIRkFgxAZAX/EuKoIZWMwPuLG3IQMdHKyo2kpfVbklWG/gHhLFO4kB0xOWmaGQBHVn dpaAP2SoecxCrDdGd5JlWRYIu8ej03b6Lwc7ZS7FIC+VaOJbfMmVa5HONuBeHJPWvMIT K70nt/GHZTJ4NLsz2xgQk1ejOhrFSnfm7GuOqBShGzFCHjEmE1kUYsTKGtWP821dXxP2 MpM9zIRshXqnYZ+9KYynNBldKyP4IeTQML4bPr0bbiDMu6zVYbUjGkQ42bBRPMJamPPQ mFf1bXsDqilwK8dsV5J3b+H+h3BDISxPUtDsWwKb5jW2hK/Hnwh6YS9RwNZCC2+QkQrF gVug== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1697842903; x=1698447703; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=Ml7q1FSw0rL1lYADaL4/tkxbt6LgDYPTklZzqqstLMk=; b=dfp3kngkQ8KySTCWdff2xRElKQyETNMY8mrwKyBy0qMiIo0z4EHlSJxBANmMptcaYt 4+yIgbpbcRCdq59aLb2Pzmw+kQBcs+8gxd9R/mEbw82E9ImNRZNsuaSzOYNIil2+xscx ZJoxyLR4hs91k7u7q6bvXFeL7jzf69VBsCUmWhIMkEFUz8Gx/Fj/1LYViHTlAGWKu3eO 7AHNIWrSYn7BAZ8hvoI1orAqvHzresJB99L7YRcjwfwzDlGgJYahPnJfdQFKLVge5OYi 2/Iawo+L4otMTMVLFkcC1BaRmENmh2+zKPAt1wlJMpV3aFk/5eZ9ngxBAgOOyWur64a6 XMxQ== X-Gm-Message-State: AOJu0YxHflWMQFb1k9EXsFliurL7Q8bUtCnqczAEmYWTnj7SJ6OK3BXc bkvoBVnTE0+CqHQv2lvCn9s= X-Google-Smtp-Source: AGHT+IGMAu5dAI4nMu+lJMwgSkbpUsNwfNWTTtS6YtQaCNm1RTuH3uI5Kd70an7LrhwBzOSTDYOEag== X-Received: by 2002:a05:6358:4320:b0:13a:bd3:3f85 with SMTP id r32-20020a056358432000b0013a0bd33f85mr2765872rwc.23.1697842902960; Fri, 20 Oct 2023 16:01:42 -0700 (PDT) Received: from hurd (dsl-156-111.b2b2c.ca. [66.158.156.111]) by smtp.gmail.com with ESMTPSA id dq16-20020a05622a521000b004181e5a724csm938370qtb.88.2023.10.20.16.01.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 20 Oct 2023 16:01:42 -0700 (PDT) From: Maxim Cournoyer In-Reply-To: <87h6mlzp9g.fsf@lassieur.org> ("=?UTF-8?Q?Cl=C3=A9ment?= Lassieur"'s message of "Fri, 20 Oct 2023 10:12:11 +0200") References: <19f82d9bbef649c750ad067d23ebbaee6f9ae494.1696942467.git.maxim.cournoyer@gmail.com> <0a5e027af3c0b61f9ab9f3c66e73b7a769eef7fd.1696983695.git.maxim.cournoyer@gmail.com> <87h6mlzp9g.fsf@lassieur.org> Date: Fri, 20 Oct 2023 19:01:41 -0400 Message-ID: <87r0logap6.fsf@gmail.com> 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-Country: US X-Migadu-Flow: FLOW_IN X-Migadu-Spam-Score: 2.88 X-Spam-Score: 2.88 X-Migadu-Queue-Id: ACC0D5E747 X-Migadu-Scanner: mx2.migadu.com X-TUID: SwmOFfi2g/ev Hi, Cl=C3=A9ment Lassieur writes: > Hi, > > These are a few questions regarding reviewing. > > 1. What should the reviewer do with old-style patches, like the ones > that don't use G-Expressions? Should we tell the submitter to use > them when possible or is it only a matter of style that is up to the > submitter? Obviously they are hard to grasp for newcomers. > > It's probably good for newcomers if we teach them how to use > G-Expressions but we don't really have time to do so, given the > number of patches waiting to be reviewed. > > This question could be extended to style issues. Like using %var > versus var. I think we should now make sure all new submissions use the current style; if they aren't we can demand of the contributors to adjust it. There is a blog post and enough examples in the code base already that should make this not too difficult. > 2. What should the reviewer do when only small changes are required? > The reviewer could do these changes in seconds whereas asking for a > new revision could take days. These changes could be indentation > fixes, removing of unused code, but they could also be more > substantial, like adding a missing `file-name` field. Or changing > old-style to G-Expressions? > > If the reviewer makes such changes and pushes them right away, I > imagine they should be documented and explained. In general, I think it's best to let the contributor know about the small problems so they can submit a v2, as they'll learn to pay attention to these. For first submissions, we can make the experience easier by adjusting locally and pushing directly for small things. This also holds for very old contributions where the original author is no longer around. I think these two points could be expound as new subsections of the 'Coding Style' section; the current scope is about codifying the human interactions more than the technical details. > 3. Should the reviewer run the program being packaged? The above > guidelines speak about applying, reading, building and linting but > not running. (Making sure it works as expected.) >From the diff: --8<---------------cut here---------------start------------->8--- +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, reading the source, building, linting and +running other people's series and sharing your comments about your +experience will give some confidence to committers, and should result in +the proposed change being merged faster. --8<---------------cut here---------------end--------------->8--- So it does mention trying out the software ("running"). --=20 Thanks, Maxim