[PATCH libinput] doc/user: expand the Contributing document

[Pekka Paalanen]

On Fri, 10 Aug 2018 15:33:42 +1000
Peter Hutterer <peter.hutterer at who-t.net> wrote:

> This is mostly taken from the Weston Contributing.md document.
> 
> Main changes from there are:
> - more detailed step-by-step on how to create a MR
> - commit history/messages in two sections
> - s/Weston/libinput/
> 
> I skipped the Review/Commit Rights sections for now until there's some demand
> for it. Same with the Licensing/Stabilising for releases sections.
> 
> Cc: Daniel Stone <daniels at collabora.com>,
> Cc: Pekka Paalanen <pekka.paalanen at collabora.co.uk>,
> Cc: Quentin Glidic <sardemff7+git at sardemff7.net>
> Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
> ---
>  doc/user/contributing.rst | 177 ++++++++++++++++++++++++++++++++++++--
>  1 file changed, 168 insertions(+), 9 deletions(-)
> 
> diff --git a/doc/user/contributing.rst b/doc/user/contributing.rst
> index 674275932..de34fb6f7 100644
> --- a/doc/user/contributing.rst
> +++ b/doc/user/contributing.rst
> @@ -5,14 +5,173 @@
>  Contributing to libinput
>  ==============================================================================
>  
> -Contributions to libinput are always welcome. Any patches should be sent to
> -the
> -`wayland-devel <https://lists.freedesktop.org/mailman/listinfo/wayland-devel>`_
> -email list with a subject prefix of ``[PATCH libinput]``. The easiest
> -way to achieve that is to run the following command in the libinput
> -repository: ::
> +Contributions to libinput are always welcome. Please see the steps below for
> +details on how to create merge requests, correct git formatting and other
> +topics:
>  
> -	git config --add format.subjectprefix "PATCH libinput"
> +.. contents::
> +    :local:
>  
> -Likewise, any new features should also be discussed publicly on the
> -wayland-devel list.
> +Questions regarding this process can be asked on ``#wayland-devel`` on
> +freenode or on the `wayland-devel at lists.freedesktop.org
> +<https://lists.freedesktop.org/mailman/listinfo/wayland-devel>`_ mailing
> +list.
> +
> +.. note:: The content of this document is largely taken from  `Weston's
> +	  CONTRIBUTING.md <https://gitlab.freedesktop.org/wayland/weston/blob/master/CONTRIBUTING.md>`_,
> +	  many thanks to the authors for their efforts.

Hi Peter,

personally I would be ok with this note being just in the commit
message.

Acked-by: Pekka Paalanen <pekka.paalanen at collabora.co.uk>


Thanks,
pq
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 833 bytes
Desc: OpenPGP digital signature
URL: <https://lists.freedesktop.org/archives/wayland-devel/attachments/20180810/714f3fca/attachment.sig>