Commit graph

15 commits

Author SHA1 Message Date
Mike Blumenkrantz
169cd3c803 governance: introduce workflow improvements
lots of small issues to resolve

Signed-off-by: Mike Blumenkrantz <michael.blumenkrantz@gmail.com>
2024-11-06 14:20:07 +00:00
Mike Blumenkrantz
11f36fbcf4 add experimental protocols and their requirements
these have a lower bar to clear for inclusion and are intended to
promote rapid development with greater community involvement

Signed-off-by: Mike Blumenkrantz <michael.blumenkrantz@gmail.com>
2024-10-31 11:58:24 +01:00
Daniel Stone
657561dcc3 README: Suggest pinging protocol authors on changes
These are usually the best people to review the changes.

Signed-off-by: Daniel Stone <daniels@collabora.com>
2024-10-09 09:07:11 +00:00
Simon Ser
f51bf51cef readme: recommend using "Draft:" prefix for RFC protocols
GitLab understands the "Draft:" prefix and will mark the MR
accordingly. GitLab used to understand the "WIP:" prefix, but
that's no longer the case.

Signed-off-by: Simon Ser <contact@emersion.fr>
2024-06-12 08:36:58 +00:00
Simon Ser
6334324035 readme: use references for links
This avoids breaking the flow of the text when inserting links.

Signed-off-by: Simon Ser <contact@emersion.fr>
2024-06-12 08:35:04 +00:00
Simon Ser
1c36a3f3ca readme: s/Makefile.am/meson.build/
We haven't been using autotools for quite a while.

Signed-off-by: Simon Ser <contact@emersion.fr>
2024-05-30 22:53:48 +02:00
Simon Ser
c4f559866f readme: make it clear that we are a standards body
wayland-protocols is more than just a repository of XML files.
Make this clear and link to the governance document and member
list.

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-11-24 18:50:43 +00:00
Simon Ser
3ec5924254 readme: version should be included in stable protocol filenames
With the new rules, we always keep the major version, even for
stable protocols.

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-11-24 18:47:38 +00:00
9ffeb975c3 README: fix typos
Signed-off-by: Vaxry <vaxry@vaxry.net>
2023-10-12 22:12:56 +01:00
Alexandros Frantzis
eb115b3137 readme: Mandate proper use of RFC 2119 keywords
This mandate makes explicit a practice that's already established in
the writing of the protocol descriptions, and officially clarifies the
meaning of the keywords for readers.

Signed-off-by: Alexandros Frantzis <alexandros.frantzis@collabora.com>
2022-06-01 16:49:06 +00:00
Simon Ser
7dffa6f346 readme: fix unformatted label references
The newlines prevent the labels from being properly formatted.
Additionally, the second label reference has a typo (extra "s").

Signed-off-by: Simon Ser <contact@emersion.fr>
2021-08-06 09:08:56 +02:00
Simon Ser
353ffc65ff readme: mention the DCO
We haven't mentionned the DCO anywhere, yet we were requiring all
contributions to have a Signed-off-by line to accept it.

Add a reference to the DCO in our README's "development procedure"
section.

Signed-off-by: Simon Ser <contact@emersion.fr>
2021-06-25 10:14:13 +02:00
Jonas Ådahl
5381e39bab Replace unstable with staging
Time has told us that the effort going from `unstable` to `stable` is
enough of a burdon meaning very few protocols are ever declared stable.

To mitigate this, and thus avoid having protocols being "stuck" being
"unstable" indefinitely, replace the "unstable" -> "stable" procedure
with a "staging" -> "stable" procedure, where declaring a protocol
stable does not involve any changes to any implementations.

The only side effect of this is that version numbers are to forever be
part of all interface names and protocol XML files.

Closes: https://gitlab.freedesktop.org/wayland/wayland-protocols/-/issues/30

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
Reviewed-by: Simon Ser <contact@emersion.fr>
2021-04-14 07:49:16 +00:00
Jonas Ådahl
91bfada605 README.md: Add some merge request triaging conventions
Add documented Gitlab procedures to help protocol reviewers and
maintainers to get a better picture of the state of merge requests. To
make this more reliable, document procedures how to triage and manage
merge requests using labels.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2020-10-14 09:45:06 +00:00
Simon Ser
733de76221 Convert plaintext documents to Markdown
This converts GOVERNANCE, MEMBERS and README to Markdown documents.
These are only cosmetic changes, the actual contents and wording have
been retained.

GitLab pretty-prints Markdown and adds anchors. We can now add links
from one document to another.

Unfortunately GOVERNANCE lettered lists have been converted to numbered
lists, because Markdown doesn't support the former.

Signed-off-by: Simon Ser <contact@emersion.fr>
Closes: https://gitlab.freedesktop.org/wayland/wayland-protocols/issues/3
2019-12-18 17:42:23 +00:00
Renamed from README (Browse further)