@open-sauced/conventional-commit

@open-sauced/conventional-commit

Never miss a conventional commit with commitizen running on npx.

📦 Install

This package is binary and doesn't require installation however you can add it to your repository as a devDependency:

npm install --save-dev @open-sauced/conventional-commit

🚀 Usage

All you have to do is run the script next to your package.json:

npx @open-sauced/conventional-commit
# or
npx conventional-commit

🔧 Configuration

The most common use case for this package is to run it instead of the git commit command inside your npm scripts:

{
  "scripts": {
    "push": "npx @open-sauced/conventional-commit"
  }
}

or

{
  "scripts": {
    "push": "npx conventional-commit"
  }
}

If you want to ensure local-only usage:

{
  "scripts": {
    "push": "conventional-commit"
  }
}

🤝 Contributing

We encourage you to contribute to Open Sauced! Please check out the Contributing guide for guidelines about how to proceed.

If you decide to fix a bug, make sure to use the conventional commit available at:

npm run push

🍕 Community

Got Questions? Join the conversation in our Discord.
Find Open Sauced videos and release overviews on our YouTube Channel.

⚖️ LICENSE

MIT © Open Sauced

Changelog

1.0.1 (2021-11-10)

Bug Fixes

• correct scoped path for commitizen binary (e3518d6), closes #25