Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 2.08 KB

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.

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 of Conduct

Participation in this project comes under the Contributor Covenant Code of Conduct

Submitting code via Pull Requests

Thank you for considering submitting code to the Global Scale Demo!

  • We follow the GitHub Pull Request Model for all contributions.
  • For large bodies of work, we recommend creating an issue outlining the feature that you wish to build, and describing how it will be implemented. This gives a chance for review to happen early, and ensures no wasted effort occurs.
  • It is strongly recommended that new API design follows the Google AIPs design guidelines.
  • All submissions, including submissions by project members, will require review before being merged.
  • Please follow the code formatting instructions below.

Formatting

When submitting pull requests, make sure to do the following:

  • Format all Terraform code with terraform fmt.
  • Format all Go code with gofmt. Many people use goimports which fixes import statements and formats code in the same style of gofmt.
  • Remove trailing whitespace. Many editors will do this automatically.
  • Ensure any new files have a trailing newline