conventional-changelog

(β˜… 8,500)

Generate changelogs and release notes from a project's commit messages and metadata.

  • .clean-publish
  • .commitlintrc.js
  • .czrc
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .nano-staged.json
  • .simple-git-hooks.json
  • .simple-release.js
  • .tool-versions
  • LICENSE.md
  • meta.md
  • oxlint.config.ts
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • tsconfig.json
  • vite.config.js

# Installation Guide

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

Downloads the entire project code from GitHub to your computer.

cd conventional-changelog

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
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.
npm install

Downloads and installs the libraries listed in package.json.

npm start

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.
// repository documentation