Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 8 commits into from
Apr 25, 2024
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,3 +145,37 @@ To create a new test:

Snapshots are created and stored in the `integ.example.ts.snapshot` directory and should be committed along with
the rest of your code.

## Windows Environment Setup

Currently `projen` does not support Windows very well.
Since this project makes use of `projen`, you will need to setup [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/about) to contribute as a Windows user.

This section guides you through setting up your Windows machine.

### Installation

Install WSL if you do not have it installed yet:\
https://learn.microsoft.com/en-us/windows/wsl/install
go-to-k marked this conversation as resolved.
Show resolved Hide resolved
EYssel marked this conversation as resolved.
Show resolved Hide resolved

Now you have access to an Ubuntu terminal powered by WSL.

> [!IMPORTANT]
>From here on it is assumed you are using the WSL terminal to run all commands.\
>You can use [Windows Terminal (Recommended)](https://apps.microsoft.com/detail/9n0dx20hk701?rtc=1&hl=en-za&gl=ZA), or you can run the `wsl` command in CMD or PowerShell.
EYssel marked this conversation as resolved.
Show resolved Hide resolved

You can now setup Node in your WSL:\
[Node Install](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl)
EYssel marked this conversation as resolved.
Show resolved Hide resolved

### Setup `aws-cdk-library` on WSL

Now that WSL is setup, you can clone this project onto your WSL machine in a preferred Directory.\
EYssel marked this conversation as resolved.
Show resolved Hide resolved

To contribute, fork the repository to your own GitHub account, and then clone it onto your machine:
go-to-k marked this conversation as resolved.
Show resolved Hide resolved
`git clone https://github.com/<your_username_here>/aws-cdk-library.git`
EYssel marked this conversation as resolved.
Show resolved Hide resolved

Open the project and confirm that your setup is working by running the following commands:
- `npm install`
- `npm run build`.
go-to-k marked this conversation as resolved.
Show resolved Hide resolved
EYssel marked this conversation as resolved.
Show resolved Hide resolved

If it runs successfully, your environment is setup correctly.
Loading