diff --git a/HACKING.md b/HACKING.md --- a/HACKING.md +++ b/HACKING.md @@ -91,5 +91,71 @@ More complete documentation can be found in [KDE's wiki](https://community.kde.org/Infrastructure/Phabricator). Please add "#KWin" as reviewers. Please run KWin's automated test suite prior to uploading a patch to ensure that the change does not break existing code. -# Coding style +## Coding style KWin code follows the [Frameworks coding style](https://techbase.kde.org/Policies/Frameworks_Coding_Style). + +## Commit message guideline +KWin uses a strict guideline (since August 2019) to improve Git history readability and simplify contributing. Most of this commit message guideline is based on [Angular's one](https://github.com/angular/angular/blob/2be061a96ed35a5157546dee9e7220c964ff4a28/CONTRIBUTING.md#commit). +### Commit message format +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +``` +(): + + + +