git Conventional Commits

106 阅读1分钟

refer:www.conventionalcommits.org/en/v1.0.0/

The commit message should be structured as follows:

	<type>[optional scope]: <description>

	[optional body]

	[optional footer(s)]

Type

    fix: bug fix for 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

Example

  feat(manager): Implement the user manager to complete user related operation
  1: Query user information by user id.
  2: Get all lists of user.
  3: Delete user information by user id.
  test(controller):