From 51ab8ade38bcb0e86aafbc4ba06331e24ca35ea0 Mon Sep 17 00:00:00 2001 From: Sergey Vartanov Date: Sun, 15 May 2022 19:02:55 +0300 Subject: [PATCH] Add commit style to documentation. --- CONTRIBUTING.md | 6 ++++++ doc/contributing.moi | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df50ee3..76b3ab7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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__ = " "` and `__email__ = ""` 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 ------------------------ diff --git a/doc/contributing.moi b/doc/contributing.moi index 22dc59e..79b97f7 100644 --- a/doc/contributing.moi +++ b/doc/contributing.moi @@ -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.