From nobody Thu May 2 15:40:35 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1666612361; cv=none; d=zohomail.com; s=zohoarc; b=YFnKGfMqFAvpS+EtgEqZUGFDgPy0MSZCTST9TfufifVai4BoaX8G57CcWN90PFXEKrlByibckH8vQun9VePoRbwDNQv0MAoEZHLc6vqycNdyGEtDu4Imn6S/0dxp/Wgo+7C9yKIX7/vDLiXx6ndQzD0o8Jv5BuT2xf1XEkCxDbA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1666612361; h=Content-Type:Content-Transfer-Encoding:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=db6rw2xOZcGOk7P62ab6CINKoQ5iOKA5+4KLrACF6cU=; b=WrmN+r4NheYYIp+QPvfU2vH5S3av6fIKilvHmsB/TIkVsxzVTxC7qqwzWR5kAU9M8n5zG7EewCgftUjLE9FIw0Dh7mQ5R7mO2eU7MtaQ7dWM6fnyZF5QcXQyzyYQNvqIpinr0Sr6tiJOD+NDXYdLWF/LDz1d5cD4BSVNHaJ7ZfI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1666612361456453.4768936753966; Mon, 24 Oct 2022 04:52:41 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-10-0OLZjoMcNqSgInRW46vakg-1; Mon, 24 Oct 2022 07:52:37 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id D18C9299E763; Mon, 24 Oct 2022 11:52:34 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 7E17B492CA2; Mon, 24 Oct 2022 11:52:34 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 2ED54194658F; Mon, 24 Oct 2022 11:52:34 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 2C8A1194658D for ; Mon, 24 Oct 2022 11:52:32 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 0347A49BB62; Mon, 24 Oct 2022 11:52:32 +0000 (UTC) Received: from maggie.redhat.com (unknown [10.43.2.39]) by smtp.corp.redhat.com (Postfix) with ESMTP id 9D3AC49BB60 for ; Mon, 24 Oct 2022 11:52:31 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1666612360; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=db6rw2xOZcGOk7P62ab6CINKoQ5iOKA5+4KLrACF6cU=; b=P/ymLI4titT2i08NXEbBF79EEuU++TTxFXB+25lNNkiK9bP29HM6vu5WHZH+Awl2y1keLV lEUC0Rn+uqIUOf+OfZPa8fqGbzA9Y4xnP3fDGpat7PpcG3j8hK0PyU6r8vD8qLCm3K+P6s 6OKhQ0a65+1w64csk4L754jJvC7eTx8= X-MC-Unique: 0OLZjoMcNqSgInRW46vakg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Michal Privoznik To: libvir-list@redhat.com Subject: [PATCH] docs: Update best practices wrt "Fixes:" and GitLab Date: Mon, 24 Oct 2022 13:52:26 +0200 Message-Id: <0f42d368ef78bbab7cea54b11f149bdf81f29d23.1666612346.git.mprivozn@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.9 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1666612361691100001 Content-Type: text/plain; charset="utf-8"; x-default="true" We document that a commit fixing an issue tracked in GitLab should put just "Fixes: #NNN" into its commit message. But when viewing git log, having full URL which is directly clickable is more developer friendly and GitLab is capable of handling both. Therefore, document that users should put full URL, just like when fixing a bug tracked in other sites. Signed-off-by: Michal Privoznik Reviewed-by: Peter Krempa --- docs/best-practices.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/best-practices.rst b/docs/best-practices.rst index ba8478ab05..a4651c19d0 100644 --- a/docs/best-practices.rst +++ b/docs/best-practices.rst @@ -15,11 +15,11 @@ with minimal back-and-forth. by any longer description of why your patch makes sense. If the patch fixes a regression, and you know what commit introduced the problem, mentioning that is useful. If the patch resolves a - upstream bug reported in GitLab, put "Fixes: #NNN" in the commit - message. For a downstream bug, mention the URL of the bug instead. - In both cases also summarize the issue rather than making all - readers follow the link. You can use 'git shortlog -30' to get - an idea of typical summary lines. + upstream bug reported in GitLab, or downstream bug, put + "Resolves: $fullURL" of the bug. In both cases also summarize + the issue rather than making all readers follow the link. You + can use 'git shortlog -30' to get an idea of typical summary + lines. =20 - Split large changes into a series of smaller patches, self-contained if possible, with an explanation of each patch --=20 2.37.4