open-index/open-npm huggingface dataset:
npm package: @manifesto-tech/generator-conventional-commits
Description: A yeoman generator for adding Conventional Commits to new or existing projects.
Author: Jack Holding
Latest version: 1.3.0

# 📦 @manifesto-tech/generator-conventional-commits
[![@manifesto-tech/generator-conventional-commits on NPM][npm-img]][npm-url]
[![Automated deployments with Semantic Release 🚀][semantic-release-img]][semantic-release]

#### A yeoman generator for adding Conventional Commits to new or existing projects.

## 🏁 Prerequisites

### ⚓ Requirements   
* [`node`][node] >= 12

## 🎉 Installation
  
1. First, install [Yeoman] and [`@manifesto-tech/generator-conventional-commits`][npm-url] using [`npm`][npm] (we assume you have pre-installed [node.js][node]).
   ```bash  
   npm install -g yo
   npm install -g @manifesto-tech/generator-conventional-commits
   ```
2. Then, navigate to the root directory of your project & run the generator
   ```bash  
   yo @manifesto-tech/conventional-commits
   ```
3. After completing the prompts, `yeoman` will run `npm install` on your behalf to install the required dependencies.
4. Confirm the files generated by `yeoman` doesn't make any unwanted changes to files that may have already existed, such as `package.json` for existing projects
5. Finally, commit the generated file changes & enjoy using Conventional Commits as part of your project! 💪😎

## 📝 Usage

See the [_Usage_][@manifesto-tech/cz-conventional-changelog#usage] section for the [`@manifesto-tech/cz-conventional-changelog`][@manifesto-tech/cz-conventional-changelog] package for details on how to use the tools installed by this generator.

## 🔧 Built with
* [Yeoman Generator][yeoman-generator]  [![yeoman-generator on NPM][yeoman-generator-img]][yeoman-generator]
    * [📝 Documentation][yeoman-generator]

## 👷 Authors
* Jack Holding - jack.holding@manifesto.co.uk

[yeoman]: http://yeoman.io
[yeoman-generator]: https://www.npmjs.com/package/yeoman-generator
[yeoman-generator-img]: https://badge.fury.io/js/yeoman-generator.svg
[yeoman-generator-docs]: https://yeoman.github.io/generator/
[npm]: https://www.npmjs.com
[node]: https://nodejs.org
[npm-url]: https://npmjs.org/package/@manifesto-tech/generator-conventional-commits
[npm-img]: https://badge.fury.io/js/%40manifesto-tech%2Fgenerator-conventional-commits.svg
[semantic-release]: https://github.com/semantic-release/semantic-release
[semantic-release-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[@manifesto-tech/cz-conventional-changelog]: https://www.npmjs.com/package/@manifesto-tech/cz-conventional-changelog
[@manifesto-tech/cz-conventional-changelog#usage]: https://www.npmjs.com/package/@manifesto-tech/cz-conventional-changelog#-usage