xsteadfastx/conventionalcommits.org
1
0
Fork 0
mirror of https://github.com/conventional-commits/conventionalcommits.org.git synced 2024-11-15 02:45:15 +01:00
Code Issues Projects Releases Wiki Activity

feat: add writing form recommendation to FAQ

Browse Source 
Add imperative present tense as our recommended writing form to the FAQ.

Closes #84 #77
This commit is contained in:
Hutson Betts 2018-08-21 09:57:02 -05:00 committed by Damiano Petrungaro
parent 8106099f20
commit f9af03c986
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
index.md
View File

@ -53,12 +53,12 @@ docs: correct spelling of CHANGELOG
### Commit message with scope
```
feat(lang): added polish language
feat(lang): add polish language
```
### Commit message for a fix using an (optional) issue number.
```
fix: minor typos in code
fix: correct minor typos in code
see the issue for details on the typos fixed
@ -118,7 +118,7 @@ We recommend that you proceed as if you've an already released product. Typicall
### Are the types in the commit title uppercase or lowercase?
Any casing may be used, but it's best to be consistent.
Any casing may be used, but it's best to be consistent.
### What do I do if the commit conforms to more than one of the commit types?
@ -156,6 +156,12 @@ In a worst case scenario, it's not the end of the world if a commit lands that d
No! If you use a squash based workflow on Git lead maintainers can cleanup the commit messages as they're merged—adding no workload to casual committers.
A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge.
### What writing form should I use?
We recommend writing a commit description and body using the [imperative](https://en.wikipedia.org/wiki/Imperative_mood) present tense writing form.
There are a significant number of examples of this writing form for commits [1](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)[2](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#subject)[3](https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project)[4](https://medium.com/@danielfeelfine/commit-verbs-101-why-i-like-to-use-this-and-why-you-should-also-like-it-d3ed2689ef70)[5](https://chris.beams.io/posts/git-commit/)
## About
The Conventional Commit specification is inspired by, and based heavily on, the [Angular Commit Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines).