@manifesto-tech/generator-conventional-commits
v1.3.0
Published
A yeoman generator for adding Conventional Commits to new or existing projects.
Downloads
4
Keywords
Readme
📦 @manifesto-tech/generator-conventional-commits
A yeoman generator for adding Conventional Commits to new or existing projects.
🏁 Prerequisites
⚓ Requirements
node
>= 12
🎉 Installation
- First, install Yeoman and
@manifesto-tech/generator-conventional-commits
usingnpm
(we assume you have pre-installed node.js).npm install -g yo npm install -g @manifesto-tech/generator-conventional-commits
- Then, navigate to the root directory of your project & run the generator
yo @manifesto-tech/conventional-commits
- After completing the prompts,
yeoman
will runnpm install
on your behalf to install the required dependencies. - Confirm the files generated by
yeoman
doesn't make any unwanted changes to files that may have already existed, such aspackage.json
for existing projects - 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
👷 Authors
- Jack Holding - [email protected]