diff options
| author | Simon Ser <contact@emersion.fr> | 2019-11-20 22:49:27 +0100 |
|---|---|---|
| committer | Simon Ser <contact@emersion.fr> | 2019-11-21 13:47:56 +0100 |
| commit | 6d0fc7065633d6056602623c9ab8376db306ec2e (patch) | |
| tree | cc93c237fdb2e45caf3948916b7bfbe84bf71f01 | |
| parent | 3c30276063c05462b71e48a6c1c23f308f6086e7 (diff) | |
| download | wayland-protocols-6d0fc7065633d6056602623c9ab8376db306ec2e.tar.xz | |
readme: changes should be submitted via GitLab
510188250ea8 ("Add governance document") adds a GOVERNANCE document
describing development based on GitLab merge requests. Update the README
file accordingly.
Some information is duplicated across README and GOVERNANCE, this is
intentional to make README provide a more human-friendly, less
bureaucratic version. GOVERNANCE is still the authoritative version.
Signed-off-by: Simon Ser <contact@emersion.fr>
| -rw-r--r-- | README | 31 |
1 files changed, 20 insertions, 11 deletions
@@ -37,17 +37,18 @@ deprecated protocols are placed in the +deprecated/+ directory. Protocol development procedure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -To propose a new protocol, create a patch adding the relevant files and -Makefile.am entry to the wayland-protocols git repository with the -explanation and motivation in the commit message. Then send the patch to -the wayland-devel@lists.freedesktop.org mailing list using -'git send-email' with the subject prefix 'RFC wayland-protocols' or -'PATCH wayland-protocols' depending on what state the protocol is in. - -To propose changes to existing protocols, create a patch with the -changes and send it to the list mentioned above while also CC:ing the -maintainers mentioned in the README file. Use the same rule for adding a -subject prefix as above and method for sending the patch. +To propose a new protocol, create a GitLab merge request adding the +relevant files and Makefile.am entry to the repository with the +explanation and motivation in the commit message. Protocols are +organized in namespaces describing their scope ("wp", "xdg" and "ext"). +There are different requirements for each namespace, see GOVERNANCE +section 2 for more information. + +If the new protocol is just an idea, open an issue on the GitLab issue +tracker. If the protocol isn't ready for complete review yet and is an +RFC, create a merge request and add the "WIP:" prefix in the title. + +To propose changes to existing protocols, create a GitLab merge request. If the changes are backward incompatible changes to an unstable protocol, see <<Unstable protocol changes>>. @@ -63,10 +64,15 @@ For generic protocols not limited to certain configurations (such as specific desktop environment or operating system) the +wp_+ prefix should be used on all interfaces in the protocol. +For protocols allowing clients to configure how their windows are +managed, the +xdg_+ prefix should be used. + For operating system specific protocols, the interfaces should be prefixed with both +wp_+ and the operating system, for example +wp_linux_+, or +wp_freebsd_+, etc. +For more information about namespaces, see GOVERNANCE section 2.1. + Unstable naming convention ~~~~~~~~~~~~~~~~~~~~~~~~~~ Unstable protocols have a special naming convention in order to make it @@ -135,6 +141,9 @@ The procedure of doing this is the following: . Update the +README+ file in the unstable directory and create a new +README+ file in the new directory. +There are other requirements for declaring a protocol stable, see +GOVERNANCE section 2.3. + Releases ~~~~~~~~ Each release of wayland-protocols finalizes the version of the protocols |