Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rwc9u committed Jan 2, 2025
1 parent f30fa6e commit 41c621c
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,19 @@ generating signatures that expire in the far future year 2036.
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Release

If you are looking to contribute in the gem you need to be aware that we are using the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification to release versions in this gem.

which means, when doing a contribution your commit message must have the following structure

```git
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
```

[here](https://www.conventionalcommits.org/en/v1.0.0/#examples) you can find some commit's examples.

0 comments on commit 41c621c

Please sign in to comment.