Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 1.87 KB
Raw

Contributing to the Pulumi ecosystem

Do you want to contribute to Pulumi? Awesome! We are so happy to have you. We have a few tips and housekeeping items to help you get up and running.

Code of Conduct

Please make sure to read and observe our Code of Conduct

Community Expectations

Please read about our contribution guidelines here.

Setting up your development environment

Pulumi prerequisites

Please refer to the main Pulumi repo's CONTRIBUTING.md file for details on how to get set up with Pulumi.

Make build system

Like the main pulumi repo, we use make as our build system. Here are some examples of the make targets:

  1. make provider, which restores/installs any build dependencies and builds the provider
  2. make build_sdks, which just builds the sdks
  3. make install_sdks, which installs the nodejs and .net sdks
  4. make build, which does all of the above

To easily test new providers, add the bin folder of this project to your path.

export PATH=$HOME/.pulumi-dev/pulumi-docker/bin:$PATH

Committing Generated Code

You must generate and check in the SDKs on each pull request containing a code change, e.g. adding a new resource to resources.go. Changelog entries are no longer needed for this repository.

  1. Run make build_sdks from the root of this repository
  2. Open a pull request containing all changes
  3. Note: If a large number of seemingly-unrelated diffs are produced by make build_sdks (for example, lots of changes to comments unrelated to the change you are making), ensure that the latest dependencies for the provider are installed by running go mod tidy in the provider/ directory of this repository.