isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-27 02:20:43 -05:00
Code Issues Packages Projects Releases Wiki Activity
947f20b1a7
mutter/doc/git-conventions.md
Florian Müllner 65d4815942 doc: Update link to commit message guidelines 
Replace the wiki page with the corresponding section in
the GNOME handbook.

Death to the wiki!

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3526>
2024-01-16 09:37:21 +00:00

1.3 KiB
Raw Blame History

Git conventions

Commit Messages

Commit messages should follow the guidelines in the GNOME handbook. We require an URL to either an issue or a merge request in each commit. Try to always prefix commit subjects with a relevant topic, such as compositor: or clutter/actor:, and it's always better to write too much in the commit message body than too little.

If a commit fixes an issue and that issue should be closed, add URL to it in the bottom of the commit message and prefix with Closes:.

Do not add any Part-of: line, as that will be handled automatically when merging.

The Fixes tag

If a commit fixes a regression caused by a particular commit, it can be marked with the Fixes: tag. To produce such a tag, use

git show -s --pretty='format:Fixes: %h ("%s")' <COMMIT>

or create an alias

git config --global alias.fixes "show -s --pretty='format:Fixes: %h (\"%s\")'"

and then use

git fixes <COMMIT>

Example

compositor: Also consider dark matter when calculating paint volume

Ignoring dark matter when calculating the paint volume missed the case where
compositing happens in complete vacuum.

Fixes: 123abc123ab ("compositor: Calculate paint volume ourselves")
Closes: https://gitlab.gnome.org/GNOME/mutter/-/issues/1234