Skip to content

Commit

Permalink
chore(doc): add Windows description in contributing guide (#25397)
Browse files Browse the repository at this point in the history
We are having some known issues to clone or build aws-cdk on Windows such as #23910 and #25164. Before we can address those issues, we should encourage Windows developers to use Gitpod or CodeCatalyst Dev Env on their Windows instead.

Closes #23910 #25164

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
pahud authored May 25, 2023
1 parent bb7f4f4 commit 43d2060
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ We recommend that you use [Visual Studio Code](https://code.visualstudio.com/) t
We use `eslint` to keep our code consistent in terms of style and reducing defects. We recommend installing
the [eslint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) as well.

Windows, as a development environment, has known performance and compatibility issues. To help in this case, consider using [Gitpod](#gitpod) or [Amazon CodeCatalyst DevEnv](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/codecatalyst-service.html) instead.

### Repo Layout

The AWS CDK is a [NPM](https://www.npmjs.com/about) project written in [typescript](https://www.typescriptlang.org/).
Expand Down

0 comments on commit 43d2060

Please sign in to comment.