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

[Daniel Stone]

Hi,

On Fri, 10 Aug 2018 at 11:39, Pekka Paalanen  wrote:
> On Fri, 10 Aug 2018 15:33:42 +1000 Peter Hutterer  
> wrote:
> > +.. note:: The content of this document is largely taken from  `Weston's
> > +   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.

AOL, it's a lovely acknowledgement but irrelevant to the target audience.

Acked-by: Daniel Stone 

Cheers,
Daniel
___
wayland-devel mailing list
wayland-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/wayland-devel

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

[Pekka Paalanen]

On Fri, 10 Aug 2018 15:33:42 +1000
Peter Hutterer  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 ,
> Cc: Pekka Paalanen ,
> Cc: Quentin Glidic 
> Signed-off-by: Peter Hutterer 
> ---
>  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 
> `_
> -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@lists.freedesktop.org
> +`_ mailing
> +list.
> +
> +.. note:: The content of this document is largely taken from  `Weston's
> +   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 


Thanks,
pq


pgp5XAR32wL3a.pgp
Description: OpenPGP digital signature
___
wayland-devel mailing list
wayland-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/wayland-devel

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

[Peter Hutterer]

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 ,
Cc: Pekka Paalanen ,
Cc: Quentin Glidic 
Signed-off-by: Peter Hutterer 
---
 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 `_
-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@lists.freedesktop.org
+`_ mailing
+list.
+
+.. note:: The content of this document is largely taken from  `Weston's
+ CONTRIBUTING.md 
`_,
+ many thanks to the authors for their efforts.
+
+--
+Submitting Code
+--
+
+Any patches should be sent via a Merge Request (see the `GitLab docs
+`_)
+in the `libinput GitLab instance hosted by freedesktop.org
+`_.
+
+To submit a merge request, you need to
+
+- `Register an account `_ in
+  the freedesktop.org GitLab instance.
+- `Fork libinput `_
+  into your username's namespace
+- Get libinput's main repository: ::
+
+git clone https://gitlab.freedesktop.org/libinput/libinput.git
+
+- Add the forked git repository to your remotes (replace ``USERNAME``
+  with your username): ::
+
+cd /path/to/libinput.git
+git remote add gitlab g...@gitlab.freedesktop.org:USERNAME/libinput.git
+git fetch gitlab
+
+- Push your changes to your fork: ::
+
+git push gitlab BRANCHNAME
+
+- Submit a merge request. The URL for a merge request is: ::
+
+https://gitlab.freedesktop.org/USERNAME/libinput/merge_requests
+
+  Select your branch name to merge and ``libinput/libinput`` ``master`` as 
target branch.
+
+--
+Commit History
+--
+
+libinput strives to have a
+`linear, 'recipe' style history 
`_
+This means that every commit should be small, digestible, stand-alone, and
+functional. Rather than a purely chronological commit history like this: ::
+
+   doc: final docs for view transforms
+   fix tests when disabled, redo broken doc formatting
+   better transformed-view iteration (thanks Hannah!)
+   try to catch more cases in tests
+   tests: add new spline test
+   fix compilation on splines
+   doc: notes on reticulating splines
+   compositor: add spline reticulation for view transforms
+
+We aim to have a clean history which only reflects the final state, broken up
+into functional groupings: ::
+
+   compositor: add spline reticulation for view transforms
+   compositor: new iterator for view transforms
+   tests: add view-transform correctness tests
+   doc: fix Doxygen formatting for view transforms
+
+This ensures that the final patch series only contains the final state,
+without the changes and missteps taken along the development process.
+
+The first line of a commit message should contain a prefix indicating
+what part is affected by the patch followed by one sentence that
+describes the change. For example: ::
+
+   touchpad: add software button behavior
+   fallback: disable button debouncing on device foo
+
+If in doubt what prefix to use, look at other commits tha