forked from trinitrix/core
1
0
Fork 0
core/docs/CommitMessageStyle.md

987 B

Commit message style

Commit messages have to align with the following style:

<type> (<space>): <change>

Pull requests that don't align with this style probably won't be accepted.

type

The type of change to be committed.

Possible values:

  • feature - When you added a new feature or functionality.
  • fix - When you fixed a bug or stuff like that.
  • docs - When you wrote documentation or changed the readme. The space field is optional here.
  • refactor - When you restructured the codebase / parts of it. The space field is optional here.

If your commit has multiple types, think about splitting it into multiple commits. This helps others (and you) to understand changes in retrospect.

space

The space that is affected by the commit.

change

What you've changed. / The actual commit message.

Examples

  • feature (AHCI): implemented port initialization
  • fix (processes): changed process spawning to copy the null terminator at the end of the name