Skip to content

Latest commit

 

History

History
executable file
·
62 lines (41 loc) · 2.44 KB

DEVELOPERS.md

File metadata and controls

executable file
·
62 lines (41 loc) · 2.44 KB
Raw

Developing inb

Git Commit Guidelines

inb follows conventional commits. This leads to more readable messages that are easy to follow when looking through the project history. Also, these git commit messages are used to generate the changelog.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Type

Must be one of the following:

  • feat: A commit of the type feat introduces a new feature to the codebase.
  • fix: A commit of the type fix patches a bug in your codebase.
  • 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.
  • build: Changes to the build.
  • ci: Changes to the Continuous integration.

Scope

The scope could be anything specifying place of the commit change. For example cli, database, console, etc...

You can use * when the change affects more than a single scope.

Subject

The subject contains succinct description of the change:

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

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

Please read the docs before developing inb, there's a lot that you need to know before developing inb.