Skip to content

Commit d4bb10f

Browse files
committed
Add release section in README
1 parent 7d9acc7 commit d4bb10f

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,5 +77,21 @@ Have a fix for a problem you've been running into or an idea for a new feature y
7777

7878
Take a look at the [Contributing document](https://github.com/fastruby/ombu_labs-auth/blob/main/CONTRIBUTING.md) for instructions to set up the repo on your machine and create a good Pull Request.
7979

80+
## Release
81+
82+
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.
83+
84+
which means, when doing a contribution your commit message must have the following structure
85+
86+
```git
87+
<type>[optional scope]: <description>
88+
89+
[optional body]
90+
91+
[optional footer(s)]
92+
```
93+
94+
[here](https://www.conventionalcommits.org/en/v1.0.0/#examples) you can find some commit's examples.
95+
8096
## License
8197
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)