npm-library

A collection of custom, reusable npm packages designed to streamline development and provide efficient solutions for a variety of tasks

Here’s a concise and clear description of the commit linting rules you can use in your README:

Commit Message Guidelines

This project uses Commitlint to enforce consistent commit message formatting. Below are the enforced rules and conventions:

Commitlint Rules

1. Commit Types:

   • The commit message type must always be one of the following:
     • feat – New feature implementation.
     • fix – Bug fixes or patches.
     • docs – Updates or improvements to documentation.
     • style – Code formatting, white-space changes, etc., with no logic changes.
     • refactor – Code restructuring without changing external behavior.
     • test – Adding or updating tests.
     • chore – Maintenance tasks such as dependency updates or build-related tasks.

2. Empty Type:

   • Commit messages must include a type. Empty types are not allowed.

Custom Plugin Rules

• A custom type-enum rule is implemented to validate the type field in commit messages. If the type is missing or invalid, the following error is shown:

  type must be one of [feat, fix, docs, style, refactor, test, chore]

Commit Message Format

A valid commit message must follow the general structure:

<type>(<optional scope>): <short description>

<optional body>

<optional footer>

Examples

• Feature: feat(auth): add user login functionality
• Bug Fix: fix(ui): resolve layout issues on mobile
• Documentation: docs: update README with usage guidelines
• Style: style: reformat code with Prettier
• Refactor: refactor(database): optimize query performance
• Test: test: add tests for user registration
• Chore: chore: update dependencies