We'd love to accept your patches and contributions to this project.
Contributions to this project must be accompanied by a Contributor License Agreement (CLA). 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.
If you or your current employer have already signed the Google CLA (even if it was for a different project), you probably don't need to do it again.
Visit https://cla.developers.google.com/ to see your current agreements or to sign a new one.
This project follows Google's Open Source Community Guidelines.
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.
The repository requires that files use the Black code formatter and style.
The repository requires that files use the Prettier code formatter and style. For more information about Prettier's configuration for this project, see the Prettier configuration file
We follow the guidelines and recommendations in the Google Cloud Best practices for using Terraform document, unless noted otherwise.
The repository requires that files use built-in formatting using the
terraform fmt command.
To setup a development environment you need:
- A POSIX-compliant shell
- An OCI-compatible container runtime. Tested with Docker for Linux 20.10.21
- An IDE or text editor
A Visual Studio Code Dev Container is included in the repository.
To set up a development environment, we designed a Visual Studio Code Dev Container that includes all the necessary tooling and Visual Studio Code (VS Code) extensions that you need to work on this project. We use this dev container to build the project from both VS Code and the command-line.
To inspect the development environment container image configuration and build
descriptors, refer to the contents of the .devcontainer directory:
- .devcontainer/devcontainer.json: development container creation and access directives (reference).
- .devcontainer/Dockerfile: dev container image build descriptor (reference).
For more information about creating containerized development environments, refer to Create a development container.
If you don't have a container runtime engine on your local host, but you have one available on a remote host, you can connect to the remote host and use that container runtime. For more information, refer to Develop on a remote Docker host.