-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add STYLE_GUIDE.md and update README.md
- Loading branch information
1 parent
411c7e4
commit c7d25a6
Showing
2 changed files
with
28 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
|
||
This document is under work-in-progress. | ||
|
||
# Git Commit Message Style | ||
|
||
## Commit Messages | ||
|
||
### Message Structure | ||
``` | ||
type: subject | ||
body | ||
footer | ||
``` | ||
|
||
### The Type | ||
* feat: a new feature | ||
* fix: a bug fix | ||
* docs: changes to documentation | ||
* style: formatting, missing semi colons, etc; no code change | ||
* refactor: refactoring production code | ||
* test: adding tests, refactoring test; no production code change | ||
* chore: updating build tasks, package manager configs, etc; no production code change | ||
|
||
### Other contents | ||
Reference to Udacity Git Commit Message Style Guide | ||
* <https://udacity.github.io/git-styleguide/> (engilish) |