Protocols in all stages have the same rules for compatibility, just
different expectations of how often breaking changes, and thus major
protocol versions, get introduced.
Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
Instead of documenting parts of each phase in different chapters,
document all the details about a specific phase in one chapter.
Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
We now have a bunch of protocol phases which we can refer to. Mentioning
protocols by the implementation detail of in which directory they are is
a bit roundabout.
This change makes sure that protocol phases are used when possible and
mentions the directory structure exhaustively in a single place.
Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
We used to call extensions to core wayland `protocol extensions`. This
terminology has been dying out and we simply refer to those things as
`protocols`. In fact, the README already uses `protocol extension`,
`extension` and `protocol` interchangeably, so let's just stick to the
modern `protocol` terminology.
Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
There is no need for two names to refer to the same thing. Let's rename
the `testing` phase to the `staging` phase.
Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
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>
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>
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>
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>
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>
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>
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>
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>
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
