Skip to content
Michael Pollind edited this page Jun 24, 2018 · 7 revisions

GitCop examines the commit subject line only.

All lines must be less than 72 characters.

Format is as follows:

type(Scope.Of.Patch): description

type - pre-defined words as follows:

  • feat, fix, docs, style, refactor, perf, test, chore, revert, cleanup, format, doc, clean

(Scope.Of.Patch) - scope or general area of affected code

  • cannot contain spaces.
  • Uppercase characters allowed.

description - this is the title for the patch using lower case only

  • no punctuation characters allowed in the description title
  • a colon and space must be added to separate the description field
  • Extra lines can be added as necessary, with no limitation except for line length.

Example of a valid commit description:

fix(Stock.Attachments): added option to add attachments on new stocks

more detail here