conventional-changelog/commitlint

Support linting more than the commit message itself

Open

#2,455 opened on Feb 17, 2021

View on GitHub
 (8 comments) (2 reactions) (0 assignees)TypeScript (896 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (15,497 stars)
PR merge metrics
 (Avg merge 12h 56m) (52 merged PRs in 30d)

Description

I would like to create a plugin for commitlint that would lint the committer/author email to only allow email domains from a list i.e. company emails only and possibly another to make sure commits are signed.

Would a PR that adds some fields to the parsed variable in the rules function be welcome?

Are there better ways of doing this maybe and it's not interesting to add support for it in commitlint?

Contributor guide

Research direction
Investigate commitlint's plugin and rule system to extend the parsed object with committer/author information. Look at existing plugins and the @commitlint/lint package for how to add new fields.
Tech stack
typescript
Domain
toolingdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60