search

open-constructs / aws-cdk-library

Community-Driven CDK Construct Library
Apache License 2.0
44 stars 6 forks source link

chore: add contribution documentation for contributors on Windows machines #17

Closed EYssel closed 3 weeks ago

EYssel commented 3 weeks ago

Adds to the CONTRIBUTING.md to help contributors on Windows machines with the setup process.

The setup requires extra non-obvious steps, such as using WSL, which merits some documentation.

EYssel commented 3 weeks ago

Thanks @go-to-k! I applied the changes and resolved the conversations.

Also added a small Note to direct users to keep the project in the WSL file system and not the "mounted" Windows C:\ drive.

EYssel commented 3 weeks ago

Also @go-to-k I see the PR docs: is not supported in the validate PR title

EYssel commented 3 weeks ago

Thanks updated as requested!

I think it may now make sense to add a general "setup" section for Linux/Mac users?

If so we can create a separate issue for this :)

go-to-k commented 3 weeks ago

Added the last comment. : https://github.com/open-constructs/aws-cdk-library/pull/17#discussion_r1579252577

I think it may now make sense to add a general "setup" section for Linux/Mac users?

If so we can create a separate issue for this :)

That's good! It's helpful!