Commits

We don't have any specific conventions for commit messages, but we recommend following the Conventional Commits specification. This will help keep your commit history clean and organized.

Here is the suggested format for commit messages:

<type>[optional scope]: <description>

[optional body]

Here are some general guidelines to follow when writing commit messages:

• Type should be one of the following:
  • feat: A new feature.
  • fix: A bug fix.
  • docs: Documentation changes.
  • style: Changes that do not affect the meaning of the code (white-space, formatting, 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 existing tests.
  • chore: Changes to the build process or auxiliary tools and libraries.
• Use the imperative mood in the subject line (e.g., "Add feature" instead of "Added feature").
• Limit the subject line to 70 characters.
• Use the body of the commit message to provide more context and details about the changes.
• Separate the subject line from the body with a blank line.
• Use bullet points to list the changes made in the commit.

warning

At the moment there is no automation in place to enforce this format, but we encourage you to follow it to keep the commit history clean and organized.