From e653f4c13e32225c2d1c304f3e6c44ff4efbdfe9 Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Mon, 12 Dec 2022 15:04:49 +0200 Subject: Documentation: contributing: Add commit message guidelines 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(+) (limited to 'Documentation') diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst index 6405c5fb..2f0b4921 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 -- cgit v1.2.1