You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This will allow the Cloud environment to target your fork correctly.
96
-
97
-
#### GitHub Codespaces
98
-
99
-
To start using GitHub Codespaces, navigate to your fork of the repository, then click on the green `Code` button, and select `Create codespace on <branch_name>` under the `Codespaces` tab (where `<branch_name>` is the branch you want to work on).
100
-
101
-
#### Local environment
102
-
103
-
Alternatively, you can use `npm run setup-local` on your local machine.
80
+
Firstly, [fork the repository](https://github.com/aws-powertools/powertools-lambda-typescript/fork), then use `npm run setup-local` on your local machine to install all dependencies and setup pre-commit hooks.
Copy file name to clipboardExpand all lines: docs/contributing/setup.md
+1-25Lines changed: 1 addition & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ graph LR
22
22
!!! question "First time contributing to an open-source project ever?"
23
23
Read this [introduction on how to fork and clone a project on GitHub](https://docs.github.com/en/get-started/quickstart/contributing-to-projects){target="_blank" rel="nofollow"}.
24
24
25
-
Unless you're using the pre-configured Cloud environment, you'll need the following installed:
25
+
You'll need the following installed:
26
26
27
27
*[GitHub account](https://github.com/join){target="_blank" rel="nofollow"}. You'll need to be able to fork, clone, and contribute via pull request.
28
28
*[Node.js 24.x](https://nodejs.org/download/release/latest-v24.x/){target="_blank" rel="nofollow"}. The repository contains an `.nvmrc` file, so if you use tools like [nvm](https://github.com/nvm-sh/nvm#nvmrc), [fnm](https://github.com/Schniz/fnm) you can switch version quickly.
@@ -35,32 +35,8 @@ Unless you're using the pre-configured Cloud environment, you'll need the follow
35
35
* [AWS Account bootstrapped with CDK](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html){target="_blank"}
36
36
* [AWS CLI installed and configured](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
37
37
38
-
## Cloud environment
39
-
40
-
!!! warning "A word of caution"
41
-
Before using one of the services below check out their pricing.
42
-
You can find more information about each service pricing respectively on [Gitpod](https://www.gitpod.io/pricing){target="_blank" rel="nofollow"} and [GitHub Codespaces](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces){target="_blank" rel="nofollow"} pages.
43
-
44
-
Once provisioned, each Cloud environment will come with all development dependencies and tools you'll need to contribute already installed.
45
-
46
-
### Gitpod
47
-
48
-
To use a pre-configured Gitpod environment, create or login to a Gitpod account, then replace `YOUR_USERNAME` with your GitHub username or organization.
1. For example, if your username is `octocat`, then the final URL should be `https://gitpod.io/#https://github.com/octocat/powertools-lambda-typescript`
55
-
56
-
### GitHub Codespaces
57
-
58
-
To use a pre-configured GitHub Codespaces environment, navigate to your fork of the repository, then click on the green `Code` button, and select `Create codespace on <branch_name>` under the `Codespaces` tab (where `<branch_name>` is the branch you want to work on).
59
-
60
38
## Local environment
61
39
62
-
> Assuming you've got all [requirements](#requirements).
63
-
64
40
You can use `npm run setup-local` to install all dependencies locally and setup pre-commit hooks.
65
41
66
42
!!! note "Curious about what `setup-local` does under the hood?"
0 commit comments