brl/gnome-shell
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Expand contribution section in README

Browse Source 
Provide a link to the relevant handbook section and some guidance
for submitting a successful merge request, instead of just throwing
two links at the user.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3122>
This commit is contained in:
Florian Müllner 2024-01-17 05:52:10 +01:00
parent afc2a7d652
commit 1f22c6681a
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -77,8 +77,23 @@ When in doubt, it is better to ask before opening an issue.
To contribute, open merge requests at https://gitlab.gnome.org/GNOME/gnome-shell.
Commit messages should follow the [commit message guidelines][commit-messages].
It can be useful to first look at the [GNOME handbook][mr-handbook].
If a change likely requires discussion beyond code review, it is probably better to
open an issue first, or follow the process for [feature requests](#feature-requests).
Otherwise, creating a separate issue is not required.
The following guidelines will help your change to be successfully merged:
* Keep the change as small as possible. If you can split it into multiple
merge requests, please do so.
* Use multiple commits. This makes it easier to review and helps to diagnose
bugs in the future.
* Use clear commit messages following the [conventions][commit-messages].
* Pay attention to the CI results. Merge requests cannot be merged until the
CI passes.
[mr-handbook]: https://handbook.gnome.org/development/change-submission.html
[commit-messages]: docs/commit-messages.md
## License