commitlint

(โ˜… 18,699)

๐Ÿ““ Lint commit messages

  • .editorconfig
  • .gitignore
  • .mise.toml
  • .npmrc
  • .nxignore
  • .oxfmtignore
  • .oxlintrc.json
  • CHANGELOG.md
  • Dockerfile.ci
  • lerna.json
  • license.md
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • tsconfig.json
  • tsconfig.shared.json
  • vitest.config.ts

# Installation Guide

1. Get the code
git clone https://github.com/conventional-changelog/commitlint

Downloads the entire project code from GitHub to your computer.

cd commitlint

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f Dockerfile.ci -t commitlint .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 commitlint

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
pnpm install

Downloads and installs the libraries listed in package.json.

pnpm build # run build tasks

Type this command into your terminal and run it.

pnpm start # rebuild on change (tsc -b --watch)

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation