2018-05-01 23:45:06 +00:00
|
|
|
# How to contribute
|
|
|
|
|
|
|
|
|
|
We definitely welcome patches and contribution to this project!
|
|
|
|
|
|
2023-12-11 11:58:19 +00:00
|
|
|
### Tips
|
|
|
|
|
|
|
|
|
|
Commits must be formatted according to the [Conventional Commits Specification](https://www.conventionalcommits.org).
|
|
|
|
|
|
|
|
|
|
Always try to include a test case! If it is not possible or not necessary,
|
|
|
|
|
please explain why in the pull request description.
|
|
|
|
|
|
|
|
|
|
### Releasing
|
|
|
|
|
|
2024-05-07 10:19:58 +00:00
|
|
|
Commits that would precipitate a SemVer change, as described in the Conventional
|
2023-12-11 11:58:19 +00:00
|
|
|
Commits Specification, will trigger [`release-please`](https://github.com/google-github-actions/release-please-action)
|
|
|
|
|
to create a release candidate pull request. Once submitted, `release-please`
|
|
|
|
|
will create a release.
|
|
|
|
|
|
|
|
|
|
For tips on how to work with `release-please`, see its documentation.
|
|
|
|
|
|
2018-05-01 23:45:06 +00:00
|
|
|
### Legal requirements
|
|
|
|
|
|
|
|
|
|
In order to protect both you and ourselves, you will need to sign the
|
|
|
|
|
[Contributor License Agreement](https://cla.developers.google.com/clas).
|
|
|
|
|
|
|
|
|
|
You may have already signed it for other Google projects.
|
