Welcome to the Open Source Commit Convention page! Below, you'll find the guidelines for committing to our Open Source repositories. These conventions help maintain consistency and make it easier for everyone to understand the changes made.

Commit Message Format

A good commit message should be informative, clear, and concise. Here's a suggested format:

[Type](Scope): Subject

Body

Footer

Type

  • 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 tests or correcting tests that fail
  • chore: Small "cosmetic" changes and code refactoring that don't affect the code's behavior

Scope

The scope is the part of the package or module that is being modified.

Subject

The subject line should start with a verb in the imperative mood (e.g., "Add", "Fix", "Update").

Body

The body should be a detailed description of the change. This is the main part of the commit message and should be more than one line.

Footer

Footers can contain additional information about the commit, such as the author or a reference to an issue in an issue tracker.

Examples

Here are a couple of examples to illustrate the commit message format:

fix: Fixed a bug in the user login process

When the user tries to log in with an invalid username or password, the application should display an error message. This commit adds the necessary validation and error handling to the login process.

chore: Updated the package.json dependencies

This commit updates the dependencies listed in the package.json file to the latest versions. No changes were made to the code itself.

Additional Resources

For more information on commit conventions, you can read the Git Commit Convention guide.

Git Commit Example