github/vim-galore
1
0
Fork 0
mirror of https://github.com/mhinz/vim-galore.git synced 2025-11-04 11:55:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING: add clause for correcting grammar/typos

Browse Source
This commit is contained in:
Marco Hinz
2016-01-06 14:17:46 +01:00
parent c56a875083
commit 9ebff465ef
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -11,11 +11,13 @@ If you want to contribute, please keep a few simple rules in mind:
- One commit per fix/addition. - One commit per fix/addition.
- The short commit message shouldn't be longer than 50 characters. - The short commit message shouldn't be longer than 50 characters.
- The short commit message must start with an uppercase character. - The short commit message must start with an uppercase character.
- The short commit message must start with the affected section followed by a - The short commit message must start with the affected section or file followed
colon (if it affects any section). by a colon.
- The short commit message must use the - The short commit message must use the
[imperative](https://en.wikipedia.org/wiki/Imperative_mood). [imperative](https://en.wikipedia.org/wiki/Imperative_mood).
- The short commit message mustn't end with a `.`. - The short commit message mustn't end with a `.`.
- The short commit message can be simply "Grammar" or "Typo", if the patch
fixes, well, grammar or typos.
- It's always a good idea to have a look at other commits to get an idea how to - It's always a good idea to have a look at other commits to get an idea how to
format one's own commits messages. format one's own commits messages.