Skip to content

commit.instructions.md

Latest commit

 

History

History
64 lines (53 loc) · 1.71 KB

commit.instructions.md

File metadata and controls

64 lines (53 loc) · 1.71 KB
description Instructions for writing clear and consistent commit messages using the Conventional Commits format.
applyTo **
tool git

Commit Message Instructions

Writing clear and consistent commit messages is important for keeping the code history understandable and traceable. Follow the Conventional Commits format:

Commit Message Structure

<type>[scope]: <short description>

  • <type>: The type of change:

    • feat: New feature.
    • fix: Bug fix.
    • docs: Documentation changes.
    • style: Code formatting without functional changes.
    • refactor: Improvements to existing code without new features.
    • test: Adding or updating tests.
    • chore: Maintenance tasks, like dependency updates.

  • [scope] (optional): The component, module, or section you worked on.

  • <short description>: Briefly describe the change in present tense (max. 50-72 characters).

Commit Message Rules

  1. Concise and specific: Use a maximum of 50-72 characters for the short description.
  2. Present tense: For example, "Add validation" instead of "Added validation".
  3. No period at the end: End the short description without a period.

Examples

New Feature

feat(header): add dropdown menu to navbar

Bug Fix

fix(api): resolve error when fetching user data

Documentation

docs(readme): add installation instructions

Refactor

refactor(utils): restructure formatting logic

Tests

test(auth): add tests for password recovery

Maintenance

chore(dependencies): update axios to v1.3.0

With these guidelines, you write consistent commit messages that help keep the codebase maintainable.