https://pulumi.com logo
#contribute
Title
# contribute
m

millions-furniture-75402

03/23/2021, 2:52 PM
Is there a general reference for getting setup locally to develop on pulumi packages, specifically awsx in this case? I’ve been reverse engineering the process from the
Makefile
, but would like to avoid blindspots. I found that
yarn
and https://github.com/pulumi/pulumictl are required, then I can run
make build_nodejs
as long as I have
tsc
in my
PATH
, so I’m able to run
make test
. Additionally, I’d like to be able to test my changes to this package in my Pulumi project before opening a PR.
Also the
CONTRIBUTING.md
seems inaccurate, unless I’m missing a step. https://github.com/pulumi/pulumi-awsx/blob/master/CONTRIBUTING.md
make test_all
does not exist in the
Makefile
and the main https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md is not very relevant to developing for this nodejs package.
b

broad-dog-22463

03/23/2021, 3:36 PM
Hey @millions-furniture-75402 You are really correct here and we don't have a good set of docs for this area - would you mind raising a bug in pulumi/pulumi and point this out so we can get it rectified? Thanks!
m

millions-furniture-75402

03/23/2021, 3:37 PM
Certainly, I’ll make a note to write something up. Here’s my first Pulumi contribution https://github.com/pulumi/pulumi-awsx/pull/654
b

broad-dog-22463

03/23/2021, 3:38 PM
I just saw it! Thanks so much 🙂 I will get it reviewed this week - I absolutely love when community members send us PRs - especially since we've not made it easy to do so!
👍 2
I will ensure that we get better CONTRIBUTING.md docs added
👍 1
m

millions-furniture-75402

03/23/2021, 5:51 PM
b

broad-dog-22463

03/23/2021, 5:53 PM
thank you so much!!
m

millions-furniture-75402

03/23/2021, 5:53 PM
There is another issue I’ve had to work-around, that I would like to open a PR for, but as I began work on the feature branch, I realized the problem is bigger than my specific use case.
For my use case,
awsx.s3.metrics.numberOfObjects
requires storageType
AllStorageTypes
— but there are many other storage types not supported referenced here: https://docs.aws.amazon.com/AmazonS3/latest/userguide/metrics-dimensions.html