hagopj13 / hagopj13/node-express-boilerplate
Can we add commit message lint?
- Dominant language
- JavaScript
- Stars
- 7.7k
- Forks
- 2.3k
- PR merge metrics
- No merged PRs in 30d
Description
**Full reference** : https://github.com/conventional-changelog/commitlint
commitlint checks if your commit messages meet the [conventional commit format](https://conventionalcommits.org/).
In general the pattern mostly looks like this:
```
type(scope?): subject #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")
```
#### Real world examples can look like this:
1. chore: run tests on travis ci
2. fix(server): send cors headers
3. feat(blog): add comment section
Common types according to [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum) can be:
- build
- chore
- ci
- docs
- feat
- fix
- perf
- refactor
- revert
- style
- test
Contributor guide
Research direction
Read the linked commitlint reference and the Conventional Commits format first. Then inspect the repository's existing Node.js project and CI configuration to determine where commit-message validation belongs; done means commits are checked against the documented format and the supported type examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, javascript, node.js
- Domain
- ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100