Metadata-Version: 2.1
Name: cz-github-convention
Version: 0.2.0
Summary: Extend the commitizen tools to create conventional commits and README that link to GitHub.
Home-page: https://github.com/evanhongo/cz-github-convention
Author: evanhongo
Author-email: evanhongo@gmail.com
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: commitizen

# What is it
## **cz-github-convention** is a plugin for [commitizen](https://github.com/commitizen-tools/commitizen)

---

# What it do

- ## Create links to GitHub commits in the CHANGELOG.md

---

# Installation

```sh
pip install cz-github-convention
cz init
```

## cz.json
```json
{
  "commitizen": {
    "name": "cz_github_convention",
    "version": "0.0.1",
    "tag_format": "v$version",
    "github_repo": "superman/super-project"
  }
}
```

## .pre-commit-config.yaml

```yaml
repos:
  - repo: https://github.com/commitizen-tools/commitizen
    rev: v2.38.0
    hooks:
      - id: commitizen
        stages: [commit-msg]
        additional_dependencies: [cz-github-convention]
```
