Merge branch 'master' of https://github.com/eegkno/commit_message_format

# By Edgar Garcia Cano
# Via Edgar Garcia Cano
* 'master' of https://github.com/eegkno/commit_message_format:
  [style>modify] New tag and use of > instead of |
  [style] Update documentation
  [docs|modify] New subtag to rename
  [docs|modify] Tags to report bugs

Author: Eric Ulises García Cano Castillo

README.md

@@ -1,4 +1,4 @@
-Commit message format (version 1.3.0)
+Commit message format (version 1.7)
 ===================
 
 ##What is it?
@@ -18,62 +18,73 @@ This is a proposal of tags to be used in commit messages. The goal is to identif
 >7. Wrap the body at 72 characters
 >8. Use the body to explain the problems, limitations, and why it is necessary. Then to explain how was addressed the issue and the effects.
 
-A complete description, rules and tips can be seen in [here][1].
+A complete description, rules and tips can be seen in [1].
 
 ####Tags and meaning for source code
 **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 (see *Rules* section)
->* [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
+>* [api] when functions, methods or classes have been added, modified or removed; method signatures or return types have changed
+>* [code] when improving the format/structure of the code, without modifying the previous functionality
+>* [main] when dealing with a file that is used as view, notebook or main file
 >* [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
+>* [new] when adding a new feature (see *Rules* section)
 >* [pkg] when libraries, frameworks, packages  or modules are added
+>* [style] when writing documentation, formatting or comments on code; no code change
+>* [test] when adding tests, refactoring tests; no production code change
+
+
 
 ####Tags and meaning for database
->* [pk] primary key
->* [fk] foreign key
+
 >* [ak] alternate key
 >* [chk] check restriction
->* [idx] index
->* [seq] sequence
+>* [col] column
+>* [dt] data type
 >* [fk] foreign key
->* [vw] view
+>* [idx] index
 >* [mv] materialize view
->* [dt] data type
->* [trg] trigger
+>* [pk] primary key
+>* [seq] sequence
 >* [tbl] table
->* [col] column
+>* [trg] trigger
+>* [vw] view
 
 ####Subtags
-Those subtags are used in order to provide the action that the commite does
+Those subtags are used in order to provide the action that the commit does
 >* *add* when something new has been added
+>* *boost* when improving performance
+>* *bug* when a bug is found (see *Rules* section)
+>* *fix* when fixing a bug (see *Rules* section)
 >* *modify* when changes in files have been made
 >* *move* when files are moved between directories
 >* *remove* when files or directories are deleted
->* *update* when a package's version is changed (see *Rules* section)
+>* *rename* when files or directories are renamed
+>* *update* when a package's version is changed, module is added, removed or modified (see *Rules* section)
+
 
 When fixing something on:
+>* *and* (*Android*)
+>* *ios*
 >* *linux*
 >* *macos*
 >* *win*
->* *and* (*Android*)
->* *ios*
->* *winp* (*Windows Phone*)
+
 
 Those subtags must be used just in combination with other tags to specify a particular change related to an O.S.
 >Example:
->  [api|macos] Subject description
+>  [api>macos] Subject description
 
 ####Rules
-The tag [new] is only used when you are doing a merge between the master and other feature-branch It is used to describe a feature.
+1. The tag [new] is only used when you are doing a merge between a feature-branch and develop.
+
+2. The tag [update] must be used just when a package is updates ([pkg|update]).
+
+3. Sometimes when you are doing modifications on your source code, it is likely to find a bug, in this case two actions can occur:
+
+>+ [api>modify+bug] when the code was modified, a bug was found but NOT fixed
+>+ [api>modify+fix] when the code was modified, a bug was found and WAS fixed
+
 
-The tag [update] must be used just when a package is updates ([pkg|update]).
 
 ##REFERENCES
 
@@ -83,4 +94,4 @@ The tag [update] must be used just when a package is updates ([pkg|update]).
 4. [Karma](http://karma-runner.github.io/0.8/dev/git-commit-msg.html)
 
 -------------
-This document was last modified on : April. 6th, 2015.
+This document was last modified on : April 6th, 2016.