3pp-mirror/map-machine
1
0
Fork 0
mirror of https://github.com/enzet/map-machine.git synced 2025-06-01 18:31:53 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add commit style to documentation.

Browse source
This commit is contained in:
Sergey Vartanov 2022-05-15 19:02:55 +03:00
parent e5a7722fd4
commit 51ab8ade38
2 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -41,6 +41,12 @@ We use [Black](http://github.com/psf/black) code formatter with maximum 80 chara
If you create new Python file, make sure you add `__author__ = "<first name> <second name>"` and `__email__ = "<author e-mail>"` string variables.
### Commit message format ###
The project uses commit messages that starts with a verb in infinitive form with first letter in uppercase, ends with a dot, and is not longer than 50 characters. E.g. `Add new icon.` or `Fix labels.`
If some issues or pull requests are referenced, commit message should starts with prefix such as `PR #123: `, `Issue #42: `, or `Fix #13: ` with the next letter in lowercase. E.g. `PR #123: refactor elements.` or `Issue #42: add icon for natural=tree.`
Suggest a tag to support
------------------------

6
doc/contributing.moi
View file

@ -35,6 +35,12 @@ We use \ref {http://github.com/psf/black} {Black} code formatter with maximum 80
If you create new Python file, make sure you add \m {__author__ = "\formal {first name} \formal {second name}"} and \m {__email__ = "\formal {author e-mail}"} string variables.
\3 {Commit message format} {}
The project uses commit messages that starts with a verb in infinitive form with first letter in uppercase, ends with a dot, and is not longer than 50 characters. E.g. \m {Add new icon.} or \m {Fix labels.}
If some issues or pull requests are referenced, commit message should starts with prefix such as \m {PR #123: }, \m {Issue #42: }, or \m {Fix #13: } with the next letter in lowercase. E.g. \m {PR #123: refactor elements.} or \m {Issue #42: add icon for natural=tree.}
\2 {Suggest a tag to support} {}
Please, create an issue describing how you would like the feature to be visualized.