Browse Source

docs(CONTRIBUTING.md): make more explicit what commit message needs

By clearly stating what commit message needs to have.
Should help with commit messages that aren't really clear.
pull/3543/head
Zetok Zalbavar 9 years ago
parent
commit
78427b8e6b
No known key found for this signature in database
GPG Key ID: C953D3880212068A
  1. 2
      CONTRIBUTING.md

2
CONTRIBUTING.md

@ -39,6 +39,8 @@ Qt:
* Provide **screenshots** for UI related changes. * Provide **screenshots** for UI related changes.
* Keep your git commit history **clean** and **precise**. Commits like * Keep your git commit history **clean** and **precise**. Commits like
`xxx fixup` should not appear. `xxx fixup` should not appear.
* Commit message should state not only what has been changed, but also why a
change is needed.
* If your commit fixes a reported issue (for example #4134), add the following * If your commit fixes a reported issue (for example #4134), add the following
message to the commit `Fixes #4134.`. message to the commit `Fixes #4134.`.
[Here is an example](https://github.com/tux3/qTox/commit/87160526d5bafcee7869d6741a06045e13d731d5). [Here is an example](https://github.com/tux3/qTox/commit/87160526d5bafcee7869d6741a06045e13d731d5).

Loading…
Cancel
Save