File tree Expand file tree Collapse file tree 4 files changed +18
-13
lines changed Expand file tree Collapse file tree 4 files changed +18
-13
lines changed Original file line number Diff line number Diff line change 1- 18
1+ 20
Original file line number Diff line number Diff line change 11# HDNET commitlint-config
22
3- This packages defines the strict implementation of the HDNET Commit Message Guidelines
4- from the HDNET Standard Recommendations
3+ This packages defines the strict implementation of the HDNET Commit Message Guidelines
4+ from the HDNET Standard Recommendations
55([ HSR-3] ( https://wiki.hdnet.de/display/OPS/HSR-3%3A+Git+Commit-Messages ) ) as npm package
6- using [ commitlint] ( https://commitlint.js.org/ )
7- through a [ shareable config] ( https://commitlint.js.org/#/concepts-shareable-config ) .
6+ using [ commitlint] ( https://commitlint.js.org/ )
7+ through a [ shareable config] ( https://commitlint.js.org/#/concepts-shareable-config ) .
88
99## Getting started
1010
11- 1 . Make sure you setup node >= 14 .
11+ 1 . Ideally, setup Node.js >= 20 .
1212
13132 . Install dependencies
1414``` bash
15- Node.js < 18
16- $ npm i -D @commitlint/cli@17 @hdnet/commitlint-config
17-
18- Node.js > = 18
1915$ npm i -D @commitlint/cli @hdnet/commitlint-config
16+
17+ For Node.js < 18:
18+ $ npm i -D @commitlint/cli@17 @hdnet/commitlint-config@0
19+
20+ For Node.js < 20:
21+ $ npm i -D @commitlint/cli@18 @hdnet/commitlint-config@0
2022```
2123
22243 . Create commitlint config (i.e. ` commitlint.config.js ` ) and extend from @hdnet/commitlint-config :
@@ -38,5 +40,5 @@ module.exports = {
3840
3941## Contribute
4042
41- To setup current node version, you can use [ nvm] ( https://github.com/nvm-sh/nvm )
43+ To setup current node version, you can use [ nvm] ( https://github.com/nvm-sh/nvm )
4244(in this project a [ .nvmrc] ( ./.nvmrc ) file is maintained).
Original file line number Diff line number Diff line change 33 "version" : " 0.2.0" ,
44 "description" : " HDNET commitlint-config, implementing HSR-3" ,
55 "author" : " HDNET" ,
6+ "engines" : {
7+ "node" : " >=20.11.0"
8+ },
69 "keywords" : [
710 " commitlint" ,
811 " hdnet" ,
Original file line number Diff line number Diff line change 1- # [ package.json] ( https://docs.npmjs.com/cli/v7 /configuring-npm/package-json )
1+ # [ package.json] ( https://docs.npmjs.com/cli/v10 /configuring-npm/package-json )
22
33> This document serves as a replacement for comments in ` package.json ` , since it includes a lot of configuration often
44> requiring explanation.
55
6- - [ scripts] ( https://docs.npmjs.com/cli/v7 /configuring-npm/package-json#scripts )
6+ - [ scripts] ( https://docs.npmjs.com/cli/v10 /configuring-npm/package-json#scripts )
77 - ` prepare ` Installs git hooks with husky. In production and CI, it omits an error
88 (i.e. husky can not be found when installed with ` npm install --omit=dev ` )
99 through husky's suggested disabled ci settings
You can’t perform that action at this time.
0 commit comments