[C4GT Community]: Implement Commit Message Linting and Automation for ECD-API

[Sneha6003]

Ticket Contents

Description

Implement commit message linting and automation for all contributors in the API repositories using Commitlint, Husky, and Commitizen. This initiative aims to enforce a consistent and readable commit history, improve collaboration, and enable automated changelogs and CI/CD processes in the future. This setup will be aligned with the practices followed across all C4GT Community repositories.

Goals

Goals

• Integrate Commitlint to enforce commit message standards.
• Set up Husky to trigger commit-msg hooks.
• Add Commitizen to provide structured commit prompts to contributors.
• Configure GitHub Actions to verify commit format in Pull Requests.

Expected Outcome

• Every commit in API repositories should follow the defined structure (e.g., Conventional Commits).
• Husky blocks non-compliant commit messages locally.
• Contributors can use the cz command to follow a guided commit format.
• GitHub Actions fail PR checks if commit messages don’t follow the required format.
• All changes remain compatible with existing CI/CD pipelines.

Acceptance Criteria

• Contributors can only commit if they follow the stipulated format.
• cz makes it easier to create standardized commit messages.
• Descriptive linting errors are shown on improper commits.
• GitHub Actions validate commit messages in PRs.
• No conflicts or interference with existing CI/CD workflows.

Implementation Details

We will be using the following tools:

• Commitlint: To enforce the use of conventional commit messages
• Husky: To add Git hooks for enforcing commit message rules
• Commitizen: To simplify the commit process using prompts

Mockups/Wireframes

No response

Product Name

AMRIT

Organisation Name

Piramal Swasthya Management and Research Institute

Domain

No response

Tech Skills Needed

Node.js

Organizational Mentor

@drtechie

Angel Mentor

No response

Complexity

Medium

Category

Configuration, CI/CD

[blazethunderstorm]

Hi @drtechie and @Sneha6003

I would like to work on this issue. Here's my proposed approach to implement commit message validation:

Proposed Approach

1. Commitlint Integration

   • Install and configure Commitlint to enforce the Conventional Commits standard.
   • Define custom rules as per repository requirements.

2. Husky Setup

   • Add Husky to manage Git hooks.
   • Configure a commit-msg hook to run Commitlint for local validation.

3. Commitizen Configuration

   • Integrate Commitizen to provide a guided CLI for writing commit messages.
   • Add an npm script (e.g., npm run commit) for easier usage.

4. GitHub Actions

   • Create or update a GitHub Actions workflow to run Commitlint during pull request checks.

5. Testing & Documentation

   • Test the setup for compatibility with existing workflows.
   • Document usage for contributors.

Let me know if this approach looks good or if any changes are needed before I proceed.

[yashgoyal0110]

I want to work on this, please assign me

[n14rishitha]

Hi @Sneha6003 @drtechie ,

I’d like to work on enforcing standardized commit messages in the API repositories using Commitlint, Husky, and Commitizen.

Here’s how I’ll approach it:
✅ Integrate Commitlint to validate commit messages (e.g., feat:, fix:, chore:).
✅ Set up Husky to block non-compliant commits pre-push.
✅ Add Commitizen (cz) for guided commit prompts.
✅ Configure GitHub Actions to check PR commit messages.
✅ Ensure zero conflicts with existing CI/CD pipelines.
I am familiar with these tools and can guide a seamless installation.
Can you assign this task to me.