Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (25 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

40 lines (25 loc) · 1.69 KB

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.

Committing Generated Code

You must generate and check in the schema and SDKs on each pull request containing provider changes.

  1. Install pre-commit and run: pre-commit install
  2. Regenerate committed artifacts before opening a PR:
    • make schema PULUMI_CONVERT=0
    • make generate_sdks PULUMI_CONVERT=0
  3. Open a pull request containing all generated changes.
  4. If a large number of unrelated diffs are produced, run go mod tidy in provider/ and regenerate.

The local pre-commit hook runs generation checks only when relevant files are staged. Use SKIP=generated-artifacts git commit ... to bypass it for one commit.

Running Integration Tests

The examples and integration tests in this repository will create and destroy real cloud resources while running. Before running these tests, make sure that you have configured access to your cloud provider with Pulumi.

TODO: Add any steps you need to take to run integration tests here