Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 1.39 KB

Contributing to terraform-provider-awsteam

First off, thanks for taking the time to contribute!

We welcome any contribution. The easiest way to start would be opening an issue. If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements below).

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

To generate or update documentation, run make gen.

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources.

make testacc

Requirements

Building The Provider

  1. Clone the repository
  2. Enter the repository directory
  3. Build the provider using the Go install command:
go install

Adding Dependencies

This provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependency github.com/author/dependency to your Terraform provider:

go get github.com/author/dependency
go mod tidy

Then commit the changes to go.mod and go.sum.

Using the provider

See the generated docs