conventional-changelog/commitlint

Support linting more than the commit message itself

Open

#2455 opened on Feb 17, 2021

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

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

Tech stack
typescriptnodejs
Domain
clideveloper experiencetooling
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
commitlint plugin systemJavaScript/TypeScriptgit commit metadata
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine the commitlint rule function signature in the source code (e.g., in packages/parse or @commitlint/types). Understand the current 'parsed' variable structure and how rules access it. Check existing custom rules or plugins for patterns. If maintainers have responded in comments, consider their input. Look for any documentation on extending the parsed object.