PHP Classes

File: toastui/docs/COMMIT_MESSAGE_CONVENTION.md

Recommend this page to a friend!
  Classes of Mark de Leon  >  PHP Document Scanner using SANE or eSCL AirPrint  >  toastui/docs/COMMIT_MESSAGE_CONVENTION.md  >  Download  
File: toastui/docs/COMMIT_MESSAGE_CONVENTION.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: PHP Document Scanner using SANE or eSCL AirPrint
Web interface to scan printed documents
Author: By
Last change:
Date: 1 year ago
Size: 1,730 bytes
 

Contents

Class file image Download

Commit Message Convention

Commit Message Format

<Type>: Short description (fix #1234)

Logger description here if necessary

BREAKING CHANGE: only contain breaking change
  • Any line of the commit message cannot be longer 100 characters!

Revert

revert: commit <short-hash>

This reverts commit <full-hash>
More description if needed

Type

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Subject

  • use the imperative, __present__ tense: "change" not "changed" nor "changes"
  • don't capitalize the first letter
  • no dot (.) at the end
  • reference GitHub issues at the end. If the commit doesn?t completely fix the issue, then use `(refs #1234)` instead of `(fixes #1234)`.

Body

  • use the imperative, __present__ tense: "change" not "changed" nor "changes".
  • the motivation for the change and contrast this with previous behavior.

BREAKING CHANGE

  • This commit contains breaking change(s).
  • start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

This convention is based on AngularJS and ESLint

For more information send a message to info at phpclasses dot org.