🚀 Feature: Implement Commit Lint for Improved Commit Message Quality ✨

[Nishitbaria]

🔖 Feature description

Novu currently lacks a commit linting system. Implementing Commit Lint in our project can significantly improve the quality of commit messages, making it easier for both contributors and team members to understand the nature of contributions. This proposal outlines the benefits and steps required to set up Commit Lint in Novu.

🎤 Why is this feature needed ?

• Improved commit message quality.
• Better organization of version history.
• Enhanced collaboration and understanding among contributors.
• Facilitates tracking and reviewing changes.

✌️ How do you aim to achieve this?

Step 1: I will Install Commit Lint

Step 2: Create a commitlint.config.js file in the project root with the following content to use the conventional commit convention:

module.exports = {
  extends: ['@commitlint/config-conventional'],
};

Step 3: Add a pre-commit hook to automatically run Commit Lint before each commit. This ensures that commit messages adhere to the convention consistently.

Step 4: Adding contributors to writing meaningful and well-structured commit messages. Emphasize the use of a clear type (e.g., feat, fix, chore) and a concise subject line.

🔄️ Additional Information

Conventional Commits: https://www.conventionalcommits.org/en/v1.0.0/

Commit Lint: https://commitlint.js.org/

👀 Have you spent some time to check if this feature request has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Contributing Guidelines

Are you willing to submit PR?

Yes I am willing to submit a PR!