D22973: docs: introduce commit message guideline

Vlad Zagorodniy <[email protected]>
Newsgroups gmane.comp.kde.devel.kwin
Message-ID <[email protected]>
zzag added a comment.


  Perhaps it's also worth to mention special git commit message keywords, e.g. BUG, CCBUG, FEATURE, FIXED-IN, CCMAIL, and so on in the footer section.

INLINE COMMENTS

> HACKING.md:120
> +* **build**: changes that affect the build system or external dependencies (example scopes: ...)
> +* **ci**: changes to our CI configuration files and scripts (example scopes: ...)
> +* **docs**: documentation only changes

Perhaps we could omit `ci` for now.

> HACKING.md:147
> +* use the imperative, present tense: "change" not "changed" nor "changes"
> +* don't capitalize the first letter
> +* no dot (.) at the end

What's the main argument for keeping the first letter in lower case?

If the first letter is not capitalized, then `<subject>` blends with `<type>(<scope>):`.

IMHO, `fix: Add more bugs to fix later` is much better than `fix: add more bugs to fix later`.

REPOSITORY
  R108 KWin

REVISION DETAIL
  https://phabricator.kde.org/D22973

To: romangg, #kwin
Cc: zzag, ngraham, kwin, LeGast00n, sbergeron, jraleigh, fbampaloukas, GB_2, mkulinski, ragreen, jackyalcine, Pitel, iodelay, crozbo, bwowk, ZrenBot, alexeymin, himcesjf, lesliezhai, ali-mohamed, hardening, romangg, jensreuterberg, abetts, sebas, apol, mart
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.