philippedurocher/semantic-commit-messages.md

Forked from joshbuchea/semantic-commit-messages.md

Last active October 20, 2020 02:39

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/philippedurocher/f6860b481886b9c4b6298c239828a180.js"></script>
Save philippedurocher/f6860b481886b9c4b6298c239828a180 to your computer and use it in GitHub Desktop.

Download ZIP

Semantic Commit Messages

Raw

semantic-commit-messages.md

Semantic Commit Messages

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

feat: (new feature for the user, not a new feature for build script)
fix: (bug fix for the user, not a fix to a build script)
docs: (changes to the documentation)
style: (formatting, missing semi colons, etc; no production code change)
refactor: (refactoring production code, eg. renaming a variable, no bug fix nor new feature)
test: (adding missing tests, refactoring tests; no production code change)
chore: (updating grunt tasks etc; no production code change eg. nuget update, etc.)
perf: (code change that improves performance)
conf: (changes that affects configurations or parameters of the app (text, json, databases)
build: (changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm))
ci: (changes to our CI configuration files and scripts (example scopes: Az Pipelines, Jarvis, Travis, SauceLabs))

References:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment