$ git commit -m"Fix typo in introduction to user guide"
Allowed <type> values: #
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)
test (adding missing tests, refactoring tests; no production code change)
chore (updating grunt tasks etc; no production code change)
git commit -m"message"
git commit -m "Write your message here"
git commit -m <msg>
git commit -message=<msg>
If your message says something like:
Make heroImage.jpg in index.html responsive,
then that's a good message.
You could adopt the convention that some developers use of
prefixing their commit messages with
feat for feature,
fix for a bugfix,
style for changes to your CSS,
docs for changes related to documentation,
refactor for refactored code or
maint for general maintenance.
Summarize changes in around 50 characters or less
More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.
Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequences of this
change? Here's the place to explain them.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded
by a single space, with blank lines in between, but conventions
vary here
If you use an issue tracker, put references to them at the bottom,
like this:
Resolves: #123
See also: #456, #789
1
I decided to update the library version and put some notes in the README to that effect. This resulted in no obvious test failures.