Browse Source

readme: add note about commit tags

pull/2/head
Alibek Omarov 6 years ago committed by GitHub
parent
commit
a69bda0b9b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 7
      CONTRIBUTING.md

7
CONTRIBUTING.md

@ -47,3 +47,10 @@
* Avoid magic numbers. * Avoid magic numbers.
* While macros are powerful, it's better to avoid overusing them. * While macros are powerful, it's better to avoid overusing them.
* If you unsure, try to mimic code style from anywhere else of engine source code. * If you unsure, try to mimic code style from anywhere else of engine source code.
* **ANY** commit message should start from declaring a tags, in format:
`tag: added some bugs`
`tag: subtag: fixed some features`
Tags can be any: subsystem, simple feature name or even just a filename, without extension.
Just keep them always same, it helps keep history clean and commit messages short.

Loading…
Cancel
Save