Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1019 Bytes

STYLEGUIDE.md

File metadata and controls

33 lines (24 loc) · 1019 Bytes

Styleguide

Use of gitmoji

This project uses gitmoji as a prefix for all commit messages

Commit Message Guidelines

GitMoji Indicator + Short (72 chars or less) summary

More detailed explanatory text. Wrap it to 72 characters. The blank
line separating the summary from the body is critical (unless you omit
the body entirely).

Write your commit message in the imperative: "Fix bug" and not "Fixed
bug" or "Fixes bug." This convention matches up with commit messages
generated by commands like git merge and git revert.

Further paragraphs come after blank lines.

- Bullet points are okay, too.
- Typically a hyphen or asterisk is used for the bullet, followed by a
  single space. Use a hanging indent.

Example for a commit message

Add CPU arch filter scheduler support

In a mixed environment of…

A properly formed git commit subject line should always be able to complete the following sentence

If applied, this commit will <your subject line here>