D22973: docs: introduce commit message guideline
Roman Gilg
noreply at phabricator.kde.org
Tue Aug 6 16:46:55 BST 2019
romangg created this revision.
romangg added a reviewer: KWin.
Herald added a project: KWin.
Herald added a subscriber: kwin.
romangg requested review of this revision.
REVISION SUMMARY
We did not have an official guideline on how commit messages are supposed to
be formatted.
Inofficially we used something like [compositor] or [platforms/drm] as tags on
the subject line. But the square brackets in the beginning can lead to issues
with certain tools.
This patch specifies an official guideline which is mostly based on the one
developed in the Angular project:
https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
Using the existing guideline of another big open source project mostly
unchanged hopefully allows us to set this guideline once and without major
changes afterwards.
Some details had to be changed though to take account of KWin's different
programming language and internal structure.
REPOSITORY
R108 KWin
BRANCH
commitMessageGuideline
REVISION DETAIL
https://phabricator.kde.org/D22973
AFFECTED FILES
HACKING.md
To: romangg, #kwin
Cc: kwin, LeGast00n, sbergeron, jraleigh, fbampaloukas, GB_2, mkulinski, ragreen, jackyalcine, Pitel, iodelay, crozbo, bwowk, ZrenBot, ngraham, alexeymin, himcesjf, lesliezhai, ali-mohamed, hardening, romangg, jensreuterberg, abetts, sebas, apol, mart
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kwin/attachments/20190806/f7df81ec/attachment.html>
More information about the kwin
mailing list