From patchwork Mon Dec 12 13:11:38 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 17979 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id D83A7C31E9 for ; Mon, 12 Dec 2022 13:11:43 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 2020E63354; Mon, 12 Dec 2022 14:11:43 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1670850703; bh=47MdW+W8msp/W2Ky+49mC0IPflRmfcvYZRkJthJgEcs=; h=To:Date:Subject:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=Wfh1Xa6bEOIHK91R4kQl+mmLA0YtX1XztfMp6qJ6JN+1zLwlx4/jpxH0/b9UG45AG eRIWIak1Dly1XDtN2sh9zXdiZWvYUr2KVA+qeFQg3L7/69oKyjr1J9U89hlXqa58uJ OG6+CdB3KfJ5PHo2TSo46h4S8GbRrjuEisiL+fAmEP1w82mCOQ8GhRwZNPN8mceU+H 0DprZ3YhMhg7HEREJ3K2LI4pxfXYNy1GwPzQPxBTibPuS3p5Kwgs5H1wT7LcxKjyo8 pnrryvIR57BA0IvT4d2InHbkWVwi+WM7iqYyzzNDXJI4nbMnAo7gifakxa+QXzFSYR K8sFnSlgDDmvw== Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 4981D6333F for ; Mon, 12 Dec 2022 14:11:41 +0100 (CET) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="m8r1z+Qd"; dkim-atps=neutral Received: from pendragon.ideasonboard.com (213-243-189-158.bb.dnainternet.fi [213.243.189.158]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id A7A666CF for ; Mon, 12 Dec 2022 14:11:40 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1670850700; bh=47MdW+W8msp/W2Ky+49mC0IPflRmfcvYZRkJthJgEcs=; h=From:To:Subject:Date:From; b=m8r1z+Qdriyvmnsb21BmkRo8m9M5HJZAwCjkCUGaGnT1OSIKvSzgOIWnLqFe54s7W 7H6BpF/jP3e5s5rG7YUsEAFYi+PcBh8nfOWnYJgSQAaiRqvCCXHTeuDvvdYVvUU7OB 3ivGH2/9cv7sm+EDu/jsu5IMAWux8hsZbe3yInL4= To: libcamera-devel@lists.libcamera.org Date: Mon, 12 Dec 2022 15:11:38 +0200 Message-Id: <20221212131138.26544-1-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.37.4 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH] Documentation: contributing: Add commit message guidelines X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Laurent Pinchart via libcamera-devel From: Laurent Pinchart Reply-To: Laurent Pinchart Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" All developers, whether junior or experienced, can benefit from improving their commit message writing skills. Add a paragraph to the contribution documentation to explain this, with a link to a good guide. Signed-off-by: Laurent Pinchart Reviewed-by: Kieran Bingham Reviewed-by: Umang Jain --- Documentation/contributing.rst | 7 +++++++ 1 file changed, 7 insertions(+) base-commit: b026e4a6a0a620ce994938c3d1babd3f3df4a47e prerequisite-patch-id: ef2a8b4c18a2688014681a8f75d7ceddaed07b99 prerequisite-patch-id: 7b397e1ed4feed4d64faf71370fc3df4a46bb2eb prerequisite-patch-id: b7d57dd39a032a92e05d3d4e22bb821b085e2291 prerequisite-patch-id: 05daa092b096bd8385c1ca3587e344570724308d diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst index 6405c5fb8a1a..2f0b4921f7e6 100644 --- a/Documentation/contributing.rst +++ b/Documentation/contributing.rst @@ -68,6 +68,13 @@ code that is as easy to read, understand and maintain as possible. This is made possible by a set of :ref:`coding-style-guidelines` that all submissions are expected to follow. +We also care about the quality of commit messages. A good commit message not +only describes what a commit does, but why it does so. By conveying clear +information about the purpose of the commit, it helps speeding up reviews. +Regardless of whether you're new to git or have years of experience, +https://cbea.ms/git-commit/ is always a good guide to read to improve your +commit message writing skills. + The patch submission process for libcamera is similar to the Linux kernel, and goes through the `libcamera-devel`_ mailing list. If you have no previous experience with ``git-send-email``, or just experience trouble configuring it