Skip to content

Commit f60d9a4

Browse files
committed
chore: set up commitizen
1 parent 20fa663 commit f60d9a4

File tree

3 files changed

+780
-133
lines changed

3 files changed

+780
-133
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![Build Status][travis-badge]][travis-badge-url]
44
[![Coverage Status][coveralls-badge]][coveralls-badge-url]
5+
[![Commitizen friendly][commitizen-badge]][commitizen]
56
[![code style: prettier][prettier-badge]][prettier-badge-url]
67

78
A simple, lightweight infinite scrolling directive for [Angular][angular] which emits an event when an element has been scrolled to the bottom.
@@ -78,6 +79,14 @@ Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protrac
7879

7980
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
8081

82+
## Making Commits
83+
84+
This repo uses [Commitizen CLI](http://commitizen.github.io/cz-cli/) and [Conventional Changelog](https://github.com/conventional-changelog/conventional-changelog) to create commits and generate changelogs. Instead of running `git commit` run `git cz` and follow the prompts. Changelogs will then be generated when creating new releases by running `npm run release`.
85+
86+
## Making Releases
87+
88+
Run `npm run release` to create a new release. This will use [Standard Version](https://github.com/conventional-changelog/standard-version) to create a new release. [Standard Version](https://github.com/conventional-changelog/standard-version) will generate / update the changelog based on commits generated using [Commitizen CLI](http://commitizen.github.io/cz-cli/), update the version number following semantic versioning rules and then commit and tag the commit for the release. Simply run `git push --follow-tags origin master`.
89+
8190
[travis-badge]: https://travis-ci.org/thisissoon/angular-infinite-scroll.svg?branch=master
8291
[travis-badge-url]: https://travis-ci.org/thisissoon/angular-infinite-scroll
8392
[coveralls-badge]: https://coveralls.io/repos/github/thisissoon/angular-infinite-scroll/badge.svg?branch=master
@@ -86,3 +95,5 @@ To get more help on the Angular CLI use `ng help` or go check out the [Angular C
8695
[angular-inviewport]: https://github.com/thisissoon/angular-inviewport
8796
[prettier-badge]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=shield
8897
[prettier-badge-url]: https://github.com/prettier/prettier
98+
[commitizen]: http://commitizen.github.io/cz-cli/
99+
[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg

0 commit comments

Comments
 (0)