https://github.com/endemolshinegroup/cz-github
A Commitizen adapter for GitHub
https://github.com/endemolshinegroup/cz-github
commitizen commitizen-adapter github typescript
Last synced: 9 months ago
JSON representation
A Commitizen adapter for GitHub
- Host: GitHub
- URL: https://github.com/endemolshinegroup/cz-github
- Owner: EndemolShineGroup
- License: mit
- Created: 2018-10-14T05:58:04.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-06T02:00:13.000Z (about 3 years ago)
- Last Synced: 2025-04-13T14:42:50.227Z (9 months ago)
- Topics: commitizen, commitizen-adapter, github, typescript
- Language: TypeScript
- Size: 1.28 MB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
![Banner][icon-banner]
[![MIT Licensed][icon-license]][link-license]
[![NPM Version][icon-npm]][link-npm]
[![Build Status][icon-ci]][link-ci]
[![Dependabot Status][icon-dependabot]][link-dependabot]
[![Code Issues][icon-issues]][link-issues]
[![Codebase Maintainability][icon-maintainability]][link-maintainability]
[![Test Coverage][icon-coverage]][link-coverage]
[![Jest][icon-jest]][link-jest]
[![Commitizen][icon-commitizen]][link-commitizen]
[![Semantic Release][icon-semantic-release]][link-semantic-release]
[![Prettier][icon-prettier]][link-prettier]
A Commitizen adapter for GitHub
## Installation
```bash
yarn add -D @endemolshinegroup/cz-github
```
Add the following to your `.czrc`:
```json
{
"path": "@endemolshinegroup/cz-github"
}
```
## Usage
[![asciicast][icon-asciicast]][link-asciicast]
## Configuration
The adapter can be customised by specifying additional options in `.czrc`:
```json
{
"path": "@endemolshinegroup/cz-github",
"@endemolshinegroup/cz-github": {
"scopes": {
"api": "For API commits",
"site": "For frontend commits",
"docs": "For documentation commits"
}
}
}
```
[icon-banner]: docs/assets/banner.png
[icon-license]: https://img.shields.io/github/license/EndemolShineGroup/cz-github.svg?longCache=true&style=flat-square
[link-license]: LICENSE
[icon-npm]: https://img.shields.io/npm/v/@endemolshinegroup/cz-github.svg?longCache=true&style=flat-square
[link-npm]: https://www.npmjs.com/package/@endemolshinegroup/cz-github
[icon-ci]: https://img.shields.io/travis/com/EndemolShineGroup/cz-github.svg?longCache=true&style=flat-square
[link-ci]: https://travis-ci.com/EndemolShineGroup/cz-github
[icon-dependabot]: https://flat.badgen.net/dependabot/EndemolShineGroup/cz-github?icon=dependabot
[link-dependabot]: https://dependabot.com/
[icon-issues]: https://img.shields.io/codeclimate/issues/EndemolShineGroup/cz-github.svg?longCache=true&style=flat-square
[link-issues]: https://codeclimate.com/github/EndemolShineGroup/cz-github/issues
[icon-maintainability]: https://img.shields.io/codeclimate/maintainability/EndemolShineGroup/cz-github.svg?longCache=true&style=flat-square
[link-maintainability]: https://codeclimate.com/github/EndemolShineGroup/cz-github
[icon-coverage]: https://img.shields.io/codecov/c/github/EndemolShineGroup/cz-github/develop.svg?longCache=true&style=flat-square
[link-coverage]: https://codecov.io/gh/EndemolShineGroup/cz-github
[icon-jest]: https://img.shields.io/badge/tested_with-jest-99424f.svg?longCache=true&style=flat-square
[link-jest]: https://jestjs.io/
[icon-commitizen]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?longCache=true&style=flat-square
[link-commitizen]: http://commitizen.github.io/cz-cli/
[icon-semantic-release]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?longCache=true&style=flat-square
[link-semantic-release]: https://semantic-release.gitbooks.io/semantic-release/
[icon-prettier]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?longCache=true&style=flat-square
[link-prettier]: https://prettier.io/
[icon-asciicast]: https://asciinema.org/a/PnzcaSPetRvFSD6lXbiLcdh3V.svg
[link-asciicast]: https://asciinema.org/a/PnzcaSPetRvFSD6lXbiLcdh3V