|
1 | | -# Contributing to Pulumi |
| 1 | +# Contributing to the Pulumi ecosystem |
2 | 2 |
|
3 | | -Do you want to hack on Pulumi? Awesome! We are so happy to have you. |
| 3 | +Do you want to contribute to Pulumi? Awesome! We are so happy to have you. |
| 4 | +We have a few tips and housekeeping items to help you get up and running. |
| 5 | + |
| 6 | +## Code of Conduct |
| 7 | + |
| 8 | +Please make sure to read and observe our [Code of Conduct](./CODE-OF-CONDUCT.md) |
| 9 | + |
| 10 | +## Community Expectations |
| 11 | + |
| 12 | +Please read about our [contribution guidelines here.](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md#communications) |
| 13 | + |
| 14 | +## Setting up your development environment |
| 15 | + |
| 16 | +### Pulumi prerequisites |
4 | 17 |
|
5 | 18 | Please refer to the [main Pulumi repo](https://github.com/pulumi/pulumi/)'s [CONTRIBUTING.md file]( |
6 | | -https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) for details on how to do so. |
| 19 | +https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md#developing) for details on how to get set up with Pulumi. |
7 | 20 |
|
8 | 21 | ## Committing Generated Code |
9 | 22 |
|
10 | | -Code generated for Pulumi SDKs should be checked in as part of the pull request containing a |
11 | | -particular change. To generate code after making changes, run `make` from the root of this |
12 | | -repository. |
| 23 | +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`. |
13 | 24 |
|
14 | | -If a large number of seemingly-unrelated diffs are produced by `make` (for example, lots of changes |
15 | | -to comments unrelated to the change you are making), ensure that the latest dependencies for the |
16 | | -provider are installed by running `make ensure` in the root of the repository. |
| 25 | +1. Run `make build_sdks` from the root of this repository |
| 26 | +1. Open a pull request containing all changes |
| 27 | +1. *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. |
17 | 28 |
|
18 | 29 | ## Running Integration Tests |
19 | 30 |
|
|
0 commit comments