@manifesto-tech/generator-conventional-commits v1.3.0

📦 @manifesto-tech/generator-conventional-commits

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

🏁 Prerequisites

⚓ Requirements

• node >= 12

🎉 Installation

1. First, install Yeoman and @manifesto-tech/generator-conventional-commits using npm (we assume you have pre-installed node.js).

   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

   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 section for the @manifesto-tech/cz-conventional-changelog package for details on how to use the tools installed by this generator.

🔧 Built with

• Yeoman Generator
  • 📝 Documentation

👷 Authors

• Jack Holding - jack.holding@manifesto.co.uk