Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/basantech89/commitizen

Last synced: 9 days ago
JSON representation

Host: GitHub
URL: https://github.com/basantech89/commitizen
Owner: basantech89
Created: 2021-12-25T17:51:30.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2022-01-27T15:27:37.000Z (about 3 years ago)
Last Synced: 2024-04-29T20:49:45.593Z (9 months ago)
Language: JavaScript
Size: 5.86 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # @awesome-tools/commitizen

### Commitizen for multi-repo or mono-repo projects. Feel free to use this package.

[![CI](https://github.com/basantech89/commitizen/actions/workflows/main.yml/badge.svg)](https://github.com/basantech89/commitizen/actions/workflows/main.yml)

[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

[![Code of Conduct](https://img.shields.io/badge/code-of%20conduct-green.svg)](https://publiclab.org/conduct)

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

	- [Things to know](#-Things-to-know)

- [Issues](#issues)

	- [🐛 Bugs](#-bugs)

	- [💡 Feature Requests](#-feature-requests)

- [LICENSE](#license)

## Installation

This module is distributed via [npm](https://www.npmjs.com/) which is bundled with [node](https://nodejs.org/) and

should be installed as one of your project's `devDependencies`:

```

npm install --save-dev @awesome-tools/commitizen

```

## Usage

Then add a script to your `package.json`:

```json5

{

  "scripts": {

    "cm": "commitizen"

  }

}

```

You can now use this script with yarn or npm

```shell

yarn cm

```

### Things to know

This project is a wrapper around `https://github.com/commitizen/cz-cli` for multi/mono repo projects

## Issues

_Looking to contribute? Look for the [Good First Issue](https://github.com/basantech89/commitizen/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)

label._ 😀

### 🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

[**See Bugs**](https://github.com/basantech89/commitizen/issues)

### 💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding

a 👍. This helps maintainers prioritize what to work on.

## LICENSE

ISC