Skip to content

Commit

Permalink
docs: add instructions for using commitizen
Browse files Browse the repository at this point in the history
  • Loading branch information
chainmywallet committed Feb 28, 2025
1 parent a01f652 commit 99d4c1e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
1 change: 0 additions & 1 deletion .github/workflows/semantic-release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ jobs:
uses: actions/setup-node@v4
with:
node-version: '23'
cache: npm

- name: Install semantic-release
run: yarn add semantic-release
Expand Down
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,29 @@ helm install <my-release> web3-helm-charts/<chart-name>

Replace `<chart-name>` with the name of the chart you want to deploy.

## Commitizen

To ensure consistent commit messages, we use Commitizen.
Please follow these steps to set it up:

1. Install Commitizen globally:

```bash
pip3 install commitizen --break-system-packages
```

2. Install the required dependencies:

```bash
git config --unset-all core.hooksPath
```

3. Install the pre-commit hooks:

```bash
pre-commit install --hook-type commit-msg
```

## Contributing

We welcome contributions! Please follow these steps to contribute:
Expand Down

0 comments on commit 99d4c1e

Please sign in to comment.