project: Document maintainers and workflow
It is important that potential contributors know who they should get in touch, who is supposed to review their work, and maintainers to know how they should introduce changes. Thus, this commit documents the current maintainers together with what they maintain, and the workflow between maintainers as well. [skip ci]
This commit is contained in:
Georges Basile Stavracas Neto
parent
9bbf9361a5
commit
b63b2bbb09
3 changed files with 143 additions and 5 deletions
|
|
@ -7,10 +7,13 @@ Please note we have a Code of Conduct, please follow it in all your interactions
|
||||||
|
|
||||||
## Pull Request Process
|
## Pull Request Process
|
||||||
|
|
||||||
1. Ensure your code compiles and doesn't break anything. Run `meson test -C <builddir>` before creating
|
1. Create a fork in GitLab and push your work to there
|
||||||
the pull request.
|
2. Open a Merge Request
|
||||||
2. If you're adding new API, it must be properly documented.
|
1. Always allow maintainer edits
|
||||||
3. The commit message is formatted as follows:
|
2. Mark the Merge Request as WIP if your work is not ready to be reviewed
|
||||||
|
3. Assign the correct maintainer to the Merge Request (see [`MAINTAINERS.md`][maintainers] to select
|
||||||
|
the correct maintainer)
|
||||||
|
4. Format commit messages as follows:
|
||||||
```
|
```
|
||||||
component: <summary>
|
component: <summary>
|
||||||
|
|
||||||
|
|
@ -68,4 +71,5 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
|
||||||
available at [http://contributor-covenant.org/version/1/4][version]
|
available at [http://contributor-covenant.org/version/1/4][version]
|
||||||
|
|
||||||
[homepage]: http://contributor-covenant.org
|
[homepage]: http://contributor-covenant.org
|
||||||
[version]: http://contributor-covenant.org/version/1/4/
|
[version]: http://contributor-covenant.org/version/1/4/
|
||||||
|
[maintainers]: https://gitlab.gnome.org/GNOME/gnome-control-center/blob/master/docs/MAINTAINERS.md
|
||||||
|
|
|
||||||
62
docs/MAINTAINERS.md
Normal file
62
docs/MAINTAINERS.md
Normal file
|
|
@ -0,0 +1,62 @@
|
||||||
|
This document describes how maintainership works on GNOME Settings. It is intended to be a guideline
|
||||||
|
for future reference.
|
||||||
|
|
||||||
|
The list of current maintainers can be found at the [gnome-control-center.doap][doap] DOAP file.
|
||||||
|
|
||||||
|
# General Rules
|
||||||
|
|
||||||
|
The purpose of the shared maintainership model in GNOME Settings is to avoid as much as possible
|
||||||
|
pushing unreviewed code in the main repository. Not only it is a good engineering practice, but it
|
||||||
|
also increases the code quality and reduces the number of bugs.
|
||||||
|
|
||||||
|
GNOME Settings has two types of maintainers:
|
||||||
|
|
||||||
|
* **General Maintainer**: take care of the whole codebase and of panels without a specific maintainer.
|
||||||
|
* **Panel Maintainer**: take care of a specific panel with a stronger authority over General
|
||||||
|
Maintainers.
|
||||||
|
|
||||||
|
|
||||||
|
## For Contributors
|
||||||
|
|
||||||
|
Panel Maintainers have a stronger authority over their panels than a General Maintainer. If you are
|
||||||
|
contributing to a specific panel, and that panel has a dedicate maintainer, they should be the main
|
||||||
|
point of contact.
|
||||||
|
|
||||||
|
In the rare case of Panel Maintainers not being responsive, it is allowed to contact General
|
||||||
|
Maintainers.
|
||||||
|
|
||||||
|
## For Maintainers
|
||||||
|
|
||||||
|
If you are a Panel Maintainer, your merge requests will be reviewed by General Maintainer. The
|
||||||
|
opposite is true as well - General Maintainers contributing to a specific panel will have their
|
||||||
|
merge requests reviewed by the Panel Maintainer of that panel.
|
||||||
|
|
||||||
|
If you are a General Maintainer contributing to an unmaintained panel, or to the main codebase, your
|
||||||
|
merge requests will be reviewed by another General Maintainer.
|
||||||
|
|
||||||
|
Avoid pushing commits without an explicit review, except in the following cases:
|
||||||
|
|
||||||
|
* The commit is a translation commit
|
||||||
|
* The commit is trivial
|
||||||
|
* The commit is urgent and no reviewers were available in time
|
||||||
|
|
||||||
|
When accepting a merge request and allowing the other maintainer to merge, avoid misunderstandings
|
||||||
|
by being explicit. Suggested acceptance phrase:
|
||||||
|
|
||||||
|
`I approve this merge request. You are allowed to merge it.`
|
||||||
|
|
||||||
|
### Urgency Commits
|
||||||
|
|
||||||
|
Urgency commits should never happen, but in case they're needed, they are defined by the following
|
||||||
|
criteria:
|
||||||
|
|
||||||
|
* On stable branches (or master right after a stable release)
|
||||||
|
* Symptoms:
|
||||||
|
* Always OR often reproducible; AND
|
||||||
|
* Crash; OR
|
||||||
|
* Data loss; OR
|
||||||
|
* System corruption
|
||||||
|
* Quickly followed by an emergency release (at most 2 days after the commit)
|
||||||
|
|
||||||
|
|
||||||
|
[doap]: https://gitlab.gnome.org/GNOME/gnome-control-center/blob/master/gnome-control-center.doap
|
||||||
|
|
@ -13,6 +13,7 @@
|
||||||
<category rdf:resource="http://api.gnome.org/doap-extensions#core" />
|
<category rdf:resource="http://api.gnome.org/doap-extensions#core" />
|
||||||
<programming-language>C</programming-language>
|
<programming-language>C</programming-language>
|
||||||
|
|
||||||
|
<!-- General -->
|
||||||
<maintainer>
|
<maintainer>
|
||||||
<foaf:Person>
|
<foaf:Person>
|
||||||
<foaf:name>Georges Basile Stavracas Neto</foaf:name>
|
<foaf:name>Georges Basile Stavracas Neto</foaf:name>
|
||||||
|
|
@ -20,4 +21,75 @@
|
||||||
<gnome:userid>gbsneto</gnome:userid>
|
<gnome:userid>gbsneto</gnome:userid>
|
||||||
</foaf:Person>
|
</foaf:Person>
|
||||||
</maintainer>
|
</maintainer>
|
||||||
|
|
||||||
|
<!-- General, Region & Language -->
|
||||||
|
<maintainer>
|
||||||
|
<foaf:Person>
|
||||||
|
<foaf:name>Robert Ancell</foaf:name>
|
||||||
|
<foaf:mbox rdf:resource="mailto:rancell@gnome.org" />
|
||||||
|
<gnome:userid>rancell</gnome:userid>
|
||||||
|
</foaf:Person>
|
||||||
|
</maintainer>
|
||||||
|
|
||||||
|
<!-- Bluetooth -->
|
||||||
|
<maintainer>
|
||||||
|
<foaf:Person>
|
||||||
|
<foaf:name>Bastien Nocera</foaf:name>
|
||||||
|
<foaf:mbox rdf:resource="mailto:hadess@gnome.org" />
|
||||||
|
<gnome:userid>hadess</gnome:userid>
|
||||||
|
</foaf:Person>
|
||||||
|
</maintainer>
|
||||||
|
|
||||||
|
<!-- Mouse & Touchpad, Printers -->
|
||||||
|
<maintainer>
|
||||||
|
<foaf:Person>
|
||||||
|
<foaf:name>Felipe Borges</foaf:name>
|
||||||
|
<foaf:mbox rdf:resource="mailto:felipeborges@gnome.org" />
|
||||||
|
<gnome:userid>felipeborges</gnome:userid>
|
||||||
|
</foaf:Person>
|
||||||
|
</maintainer>
|
||||||
|
|
||||||
|
<!-- Online Accounts -->
|
||||||
|
<maintainer>
|
||||||
|
<foaf:Person>
|
||||||
|
<foaf:name>Debarshi Ray</foaf:name>
|
||||||
|
<foaf:mbox rdf:resource="mailto:debarshir@gnome.org" />
|
||||||
|
<gnome:userid>debarshir</gnome:userid>
|
||||||
|
</foaf:Person>
|
||||||
|
</maintainer>
|
||||||
|
|
||||||
|
<!-- Printers -->
|
||||||
|
<maintainer>
|
||||||
|
<foaf:Person>
|
||||||
|
<foaf:name>Marek Kašík</foaf:name>
|
||||||
|
<foaf:mbox rdf:resource="mailto:mkasik@gnome.org" />
|
||||||
|
</foaf:Person>
|
||||||
|
</maintainer>
|
||||||
|
|
||||||
|
<!-- Thunderbolt -->
|
||||||
|
<maintainer>
|
||||||
|
<foaf:Person>
|
||||||
|
<foaf:name>Christian Kellner</foaf:name>
|
||||||
|
<foaf:mbox rdf:resource="mailto:gicmo@gnome.org" />
|
||||||
|
<gnome:userid>gicmo</gnome:userid>
|
||||||
|
</foaf:Person>
|
||||||
|
</maintainer>
|
||||||
|
|
||||||
|
<!-- User Accounts -->
|
||||||
|
<maintainer>
|
||||||
|
<foaf:Person>
|
||||||
|
<foaf:name>Ondrej Holy</foaf:name>
|
||||||
|
<foaf:mbox rdf:resource="mailto:oholy@gnome.org" />
|
||||||
|
<gnome:userid>oholy</gnome:userid>
|
||||||
|
</foaf:Person>
|
||||||
|
</maintainer>
|
||||||
|
|
||||||
|
<!-- Wacom -->
|
||||||
|
<maintainer>
|
||||||
|
<foaf:Person>
|
||||||
|
<foaf:name>Carlos Garnacho</foaf:name>
|
||||||
|
<foaf:mbox rdf:resource="mailto:carlosg@gnome.org" />
|
||||||
|
<gnome:userid>carlosg</gnome:userid>
|
||||||
|
</foaf:Person>
|
||||||
|
</maintainer>
|
||||||
</Project>
|
</Project>
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue