diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f5eea4069..4ebe79f8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,6 +25,7 @@ OS version: # Opening a pull request ### Must read +* Use **[commit message format](#commit-message-format)**. * Read our [**coding guidelines**](https://github.com/tux3/qTox/wiki/Coding). * Keep the title **short** and provide a **clear** description about what your pull request does. * Provide **screenshots** for UI related changes. @@ -35,3 +36,71 @@ OS version: * **Search** the pull request history! Others might have already implemented your idea and it could be waiting to be merged (or have been rejected already). Save your precious time by doing a search first. * When resolving merge conflicts, do `git rebase `, don't do `git pull`. Then you can start fixing the conflicts. [Here is a good explanation](https://www.atlassian.com/git/tutorials/merging-vs-rebasing). + +## Git Commit Guidelines + +We have very precise rules over how our git commit messages can be formatted. +This leads to **more readable messages** that are easy to follow when looking +through the **project history**. But also, we use the git commit messages to +**generate the qTox change log** using [clog-cli] +(https://github.com/clog-tool/clog-cli). + + +### 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**: + +``` +(): + + + +