Commit Message Standards

As we begin building the application, it is important to follow a consistent commit message format. We should use Conventional Commits to ensure clarity and maintain a structured history.

Format

• type: The category of change (e.g., feat, fix, chore, docs, style, refactor, test)
• scope: The area of the code affected (e.g., login, api, UI), optional but recommended
• message: A concise description of the change, written in the imperative mood (e.g., Add user login API endpoint)

Types of Commits

• feat: A new feature for the user
• fix: A bug fix
• chore: Routine tasks, maintenance
• docs: Documentation updates
• style: Formatting changes (e.g., missing semicolons, whitespace)
• refactor: Code changes that neither fix bugs nor add features
• test: Adding or updating tests

Examples

• feat(login): add user authentication page
• fix(api): correct endpoint response for user data
• docs(readme): update instructions for setup
• repo: update issue template for bug issues
• chore: remove unused dependencies

Why Use Conventional Commits?

• Consistency: Helps team members quickly understand the purpose of changes.
• Automation: Enables automated versioning and changelog generation.
• Clarity: Ensures a clean and easy-to-read Git history.

Starting Soon

We’ll begin applying these standards in the upcoming weeks, so please start using Conventional Commits right away to ensure a smooth development process.