Commit Message Conventions - liuninglin/pandama-ext GitHub Wiki

Commit Message Format

Each commit message only consists of a type and a subject, the detailed description should be put into your pull request description. Commit messages should keep short, simple, and human-readable.

<type>: <subject>

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Subject

The subject contains a succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize the first letter
  • no dot (.) at the end

References

This guideline was created based on the Angular convention.

⚠️ **GitHub.com Fallback** ⚠️