40 lines
853 B
Markdown
40 lines
853 B
Markdown
# rcz
|
|
|
|
Resultium commit standardization library
|
|
|
|
## Installation
|
|
|
|
1. Set up @resultium registry in an .npmrc file in your home directory with following content:
|
|
```
|
|
@resultium:registry=https://git.resultium.net/api/packages/technology/npm/
|
|
```
|
|
2. Install the package using npm
|
|
```
|
|
npm install -g @resultium/rcz
|
|
```
|
|
|
|
## Getting started
|
|
|
|
1. Make changes to your git initialized project
|
|
2. Run `rcz commit` in the root directory
|
|
- if you wish to sign your commit use `--sign` option
|
|
3. Answer all the questions
|
|
4. Push to remote
|
|
|
|
## Configuration
|
|
|
|
You can create an `.rczrc`, `.rczrc.json` or `rcz.config.json` file in your root directory and specify available scopes and commit types
|
|
|
|
```json
|
|
{
|
|
"scopes": ["forms"],
|
|
"types": [
|
|
{
|
|
"label": "chore",
|
|
"value": "chore",
|
|
"hint": "a routine action"
|
|
}
|
|
]
|
|
}
|
|
```
|