Skip to content

Commit

Permalink
fix: 🐛 adding readme notes (#191)
Browse files Browse the repository at this point in the history
* fix: 🐛 adding readme notes

* fix(doc) typo in readme

Co-authored-by: Steve Pieper <[email protected]>
  • Loading branch information
Punzo and pieper authored Mar 9, 2021
1 parent fdc3e25 commit e2a877b
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,21 @@ Use the following "Commit Message Format" when drafting commit messages. If you'
Note: Be wary of `BREAKING_CHANGE` in commit message descriptions, as this can force a major version bump.

Be sure to use lower case for the first letter of your semantic commit message, so use `fix` not `Fix` or `feat` not `Feat`.
It is advised to use the git-cz, i.e.:

- install git-cz

```
npm install -g git-cz
```

- how to commit

```
git-cz --non-interactive --type=fix --subject="commit message"
```

More info at [git-cz](https://www.npmjs.com/package/git-cz).

Note: a new package version will be published only if the commit comes from a PR.

Expand Down

0 comments on commit e2a877b

Please sign in to comment.