Skip to content

Commit dc26c55

Browse files
Merge pull request #140 from pulumi/guin/update-contributing
Update Contributor Guide
2 parents c1df630 + 3441437 commit dc26c55

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,30 @@
1-
# Contributing to Pulumi
1+
# Contributing to the Pulumi ecosystem
22

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
417

518
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.
720

821
## Committing Generated Code
922

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`.
1324

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.
1728

1829
## Running Integration Tests
1930

0 commit comments

Comments
 (0)