2018-04-26 17:52:06 +00:00
|
|
|
# How to Contribute
|
|
|
|
|
|
|
|
|
|
We'd love to accept your patches and contributions to this project. There are
|
|
|
|
|
just a few small guidelines you need to follow.
|
|
|
|
|
|
2021-06-03 20:30:26 +00:00
|
|
|
## Formatting
|
|
|
|
|
|
|
|
|
|
Starlark files should be formatted by buildifier.
|
|
|
|
|
We suggest using a pre-commit hook to automate this.
|
|
|
|
|
First [install pre-commit](https://pre-commit.com/#installation),
|
|
|
|
|
then run
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
pre-commit install
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Otherwise the Buildkite CI will yell at you about formatting/linting violations.
|
|
|
|
|
|
2018-04-26 17:52:06 +00:00
|
|
|
## Contributor License Agreement
|
|
|
|
|
|
|
|
|
|
Contributions to this project must be accompanied by a Contributor License
|
|
|
|
|
Agreement. You (or your employer) retain the copyright to your contribution,
|
|
|
|
|
this simply gives us permission to use and redistribute your contributions as
|
|
|
|
|
part of the project. Head over to <https://cla.developers.google.com/> to see
|
|
|
|
|
your current agreements on file or to sign a new one.
|
|
|
|
|
|
|
|
|
|
You generally only need to submit a CLA once, so if you've already submitted one
|
|
|
|
|
(even if it was for a different project), you probably don't need to do it
|
|
|
|
|
again.
|
|
|
|
|
|
|
|
|
|
## Code reviews
|
|
|
|
|
|
|
|
|
|
All submissions, including submissions by project members, require review. We
|
|
|
|
|
use GitHub pull requests for this purpose. Consult
|
|
|
|
|
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
|
|
|
|
|
information on using pull requests.
|
|
|
|
|
|
|
|
|
|
## Community Guidelines
|
|
|
|
|
|
|
|
|
|
This project follows [Google's Open Source Community
|
|
|
|
|
Guidelines](https://opensource.google.com/conduct/).
|
