Skip to content

ericgcc/commit_message_format

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 

Repository files navigation

Commit message format (version 1.0.0)

##What is it? This is a proposal of tags to be used in commit messages. The goal is to identify easily the different types of changes in the project's repo.

##Commit Message rules

####Subject desription (first line)

  1. Prefix the line with an applicable emoji (tag)
  2. Limit the subject line to 50 characters
  3. Separate subject from body with a blank line
  4. Capitalize the subject line
  5. Do not end the subject line with a period
  6. Use the imperative mood in the subject line

####Message body

  1. Wrap the body at 72 characters
  2. Use the body to explain the problems, limitations, and why is it necessary?. Then to explain how was addressed the issue and the effects.

A complete description, rules and tips can be seen in here.

####Tags and meaning NOTE: The first commit does not have a label, and the message always is "Initial commit" as convention.

  • [style] when formatting or comments on code; no code change
  • [docs] when writing documentation
  • [code] when improving the format/structure of the code
  • [bug] when fixing a bug
  • [new] when adding new feature
  • [api] when functions, methods or classes have been added or removed; method signatures or return types have changed
  • [typo] when typos in words or minimal changes in comment sentences
  • [misc] anything not covered by the above categories, e.g. rename or move files, add configuration files, add dataset
  • [test] when adding tests, refactoring tests; no production code change
  • [boost] when improving performance
  • [pkg] when libraries, frameworks, packages or modules are added

####Subtags

  • linux when fixing something on Linux
  • macos when fixing something on Mac OS
  • win when fixing something on Windows
  • and when fixing something on Android
  • ios when fixing something on iOS
  • winp when fixing something on Windows Phone

NOTE: The subtags linux, macos,and, win, ios and winp must be used just in combination with other tags to specify a particular change related to an O.S.

Example: [api|macos] Subject description

##REFERENCES

  1. How to Write a Git Commit Message Chris Beams
  2. [TYPO3 CMS](http://wiki.typo3.org/CommitMessage_Format_(Git)
  3. Atom
  4. Karma

------------- This document was last modified on : April. 6th, 2015.

About

Commit message rules

Resources

Stars

Watchers

Forks

Packages

No packages published