Skip to content
This repository has been archived by the owner on Jun 16, 2021. It is now read-only.

Commit

Permalink
docs: 📝 @jeromefitz/git-cz intall updates, why this fork 🍴️
Browse files Browse the repository at this point in the history
  • Loading branch information
JeromeFitz authored and kodiakhq[bot] committed May 1, 2021
1 parent be2a01a commit f2247ba
Showing 1 changed file with 31 additions and 17 deletions.
48 changes: 31 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,46 @@
# git-cz
# @jeromefitz/git-cz

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

![image](https://user-images.githubusercontent.com/9773803/49760520-fa6c6f00-fcc4-11e8-84c4-80727f071487.png)
## Why this Fork

```bash
npm i -g git-cz
added 1 package in 0.612s
```

Installs in 0.6s vs 31.1s.

### But Why _this_ Fork

I needed to customize some things, and seemed like the intent was breaking away from [`streamich/git-cz`](https://github.com/streamich/git-cz).

- [x] Package Upgrades
- [x] Node12 Support
- [x] Subject Customization
- [x] Theming: Gitmoji ✨️
- Semantic Versioning Requirements for CI/CD
- [x] Gitflow Brancing
- CLI Customizations
- [x] Codestyle Preference
- Getting there
- [ ] TypeScript Migration
- Eventually getting there

## Install

### Without installation

```shell
npx git-cz
yarn git-cz
# or
npx git-cz -e
yarn git-cz -e
```

### Install globally standalone

```shell
npm install -g git-cz
yarn global install @jeromefitz/git-cz
git-cz
# or
git-cz -e
Expand All @@ -26,8 +49,8 @@ git-cz -e
### Install locally with Commitizen

```shell
npm install -g commitizen
npm install --save-dev git-cz
yarn global install commitizen
yarn install --save-dev @jeromefitz/git-cz
```

`package.json`:
Expand All @@ -51,7 +74,7 @@ git cz
### Install globally with Commitizen

```shell
npm install -g commitizen git-cz
yarn global install commitizen @jeromefitz/git-cz
commitizen init git-cz --save-dev --save-exact
```

Expand Down Expand Up @@ -294,15 +317,6 @@ Select the packages the commit affected.

The footer is the place to reference any tasks related to this commit.

## Why this Fork

```bash
npm i -g git-cz
added 1 package in 0.612s
```

Installs in 0.6s vs 31.1s.

```bash
npm i -g mol-conventional-changelog
added 345 packages in 31.076s
Expand Down

0 comments on commit f2247ba

Please sign in to comment.