https://github.com/0-vortex/open-sauced-conventional-commit-test

Experimenting with commitizen configuration repository for opensauced.pizza
https://github.com/0-vortex/open-sauced-conventional-commit-test

Last synced: 9 days ago
JSON representation

Experimenting with commitizen configuration repository for opensauced.pizza

• Host: GitHub
• URL: https://github.com/0-vortex/open-sauced-conventional-commit-test
• Owner: 0-vortex
• License: mit
• Created: 2021-11-08T17:59:49.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-08T21:37:55.000Z (about 3 years ago)
• Last Synced: 2024-11-05T05:49:11.861Z (12 days ago)
• Language: JavaScript
• Homepage:
• Size: 335 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


# @open-sauced/conventional-commit

> Never break your dependency tree with [**npm-install-checks**](https://www.npmjs.com/package/npm-install-checks) running on [**npx**](https://www.npmjs.com/package/npx).

[![Commits](https://img.shields.io/github/commit-activity/w/open-sauced/conventional-commit?style=flat)](https://github.com/open-sauced/conventional-commit/pulse)

[![Issues](https://img.shields.io/github/issues/open-sauced/conventional-commit.svg?style=flat)](https://github.com/open-sauced/conventional-commit/issues)

[![Releases](https://img.shields.io/github/v/release/open-sauced/conventional-commit.svg?style=flat)](https://github.com/open-sauced/conventional-commit/releases)

[![Discord](https://img.shields.io/discord/714698561081704529.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/U2peSNf23P)

[![Twitter](https://img.shields.io/twitter/follow/saucedopen?label=Follow&style=social)](https://twitter.com/saucedopen)



## 📦 Install

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

```shell

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

```

## 🚀 Usage

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

```shell

npx @open-sauced/conventional-commit

```

## 🔧 Configuration

The most common use case for this package is to let it run on `install` and `start` generic `npm` scripts:

```json

{

  "scripts": {

    "push": "npx @open-sauced/conventional-commit"

  }

}

```

## 🤝 Contributing

We encourage you to contribute to Open Sauced! Please check out the [Contributing guide](https://docs.opensauced.pizza/) for guidelines about how to proceed.

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

```shell

npm run push

```



## 🍕 Community

Got Questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P).  

Find Open Sauced videos and release overviews on our [YouTube Channel](https://www.youtube.com/channel/UCklWxKrTti61ZCROE1e5-MQ).

## ⚖️ LICENSE

MIT © [Open Sauced](LICENSE)