[libcamera-devel] Documentation: Briefly document the mail-based contribution process

15621 diff mbox series

While familiarity with git is nowadays common, many developers are not
familiar with mail-based patch submission. Add a paragraph to the
contribution guide to mention that libcamera uses a mail-based process
(which seems to have been taken for granted so much that we forgot to
say it explicitly), and link to git-send-email.io to help newcomers
setup git-send-email.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/contributing.rst | 6 ++++++
 1 file changed, 6 insertions(+)


base-commit: a2aa1b4c4e441b7b2fb40c976489b109c1de0bc4

Hi,

Thank you for the patch.

On 4/5/22 23:44, Laurent Pinchart via libcamera-devel wrote:
> While familiarity with git is nowadays common, many developers are not
> familiar with mail-based patch submission. Add a paragraph to the
> contribution guide to mention that libcamera uses a mail-based process
> (which seems to have been taken for granted so much that we forgot to
> say it explicitly), and link to git-send-email.io to help newcomers
> setup git-send-email.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>   Documentation/contributing.rst | 6 ++++++
>   1 file changed, 6 insertions(+)
>
> diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst
> index b192c3b43153..8f06e3647e5d 100644
> --- a/Documentation/contributing.rst
> +++ b/Documentation/contributing.rst
> @@ -68,6 +68,12 @@ 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.
>   
> +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 trouble configuring it for your


s/trouble/have trouble/ maybe?

Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>

> +e-mail provider, the sourcehut developers have put together a detailed guide
> +available at https://git-send-email.io/.
> +
>   Patches submitted to the libcamera project must be certified as suitable for
>   integration into an open source project. As such libcamera follows the same
>   model as utilised by the Linux kernel, and requires the use of 'Signed-off-by:'
>
> base-commit: a2aa1b4c4e441b7b2fb40c976489b109c1de0bc4

With the issue pointed out by Umang fixed

Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>

Thanks
  j

On Tue, Apr 05, 2022 at 09:14:28PM +0300, Laurent Pinchart via libcamera-devel wrote:
> While familiarity with git is nowadays common, many developers are not
> familiar with mail-based patch submission. Add a paragraph to the
> contribution guide to mention that libcamera uses a mail-based process
> (which seems to have been taken for granted so much that we forgot to
> say it explicitly), and link to git-send-email.io to help newcomers
> setup git-send-email.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  Documentation/contributing.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
>
> diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst
> index b192c3b43153..8f06e3647e5d 100644
> --- a/Documentation/contributing.rst
> +++ b/Documentation/contributing.rst
> @@ -68,6 +68,12 @@ 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.
>
> +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 trouble configuring it for your
> +e-mail provider, the sourcehut developers have put together a detailed guide
> +available at https://git-send-email.io/.
> +
>  Patches submitted to the libcamera project must be certified as suitable for
>  integration into an open source project. As such libcamera follows the same
>  model as utilised by the Linux kernel, and requires the use of 'Signed-off-by:'
>
> base-commit: a2aa1b4c4e441b7b2fb40c976489b109c1de0bc4
> --
> Regards,
>
> Laurent Pinchart
>