Skip to content

Commit b434d9f

Browse files
authored
docs: Use numbered list for env setup in Contribution Guide (#1604)
1 parent c1dab73 commit b434d9f

File tree

1 file changed

+33
-28
lines changed

1 file changed

+33
-28
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -50,34 +50,39 @@ See [sdk-structure.md](./docs/sdk-structure.md)
5050

5151
### Environment setup
5252

53-
- The TS SDK can be executed on 18, 20 or 22. However, we recommend using Node 22 for SDK development.
54-
For easier testing during development you may want to use a version manager, such as
55-
[fnm](https://github.com/Schniz/fnm) or [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md).
56-
57-
- To run tests, you will need access to a local Temporal server, e.g. using the
58-
[Temporal CLI's integrated dev server](https://github.com/temporalio/cli#start-the-server).
59-
- Install the [Rust toolchain](https://rustup.rs/).
60-
- Install [Protocol Buffers](https://github.com/protocolbuffers/protobuf/releases/).
61-
- Clone the [sdk-typescript](https://github.com/temporalio/sdk-typescript) repo:
62-
```sh
63-
git clone https://github.com/temporalio/sdk-typescript.git
64-
cd sdk-typescript
65-
```
66-
- Initialize the Core SDK submodule:
67-
```sh
68-
git submodule update --init --recursive
69-
```
70-
> If you get a `The authenticity of host 'github.com (192.30.252.123)' can't be established.`
71-
> error, run `ssh-keyscan github.com >> ~/.ssh/known_hosts` and retry.
72-
- Install the dependencies:
73-
```sh
74-
npm ci
75-
```
76-
This may take a few minutes, as it involves downloading and compiling Rust dependencies.
77-
- You should now be able to build:
78-
```sh
79-
npm run build
80-
```
53+
The TS SDK can be executed on 18, 20 or 22. However, we recommend using Node 22 for SDK development.
54+
For easier testing during development you may want to use a version manager, such as
55+
[fnm](https://github.com/Schniz/fnm) or [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md).
56+
57+
1. To run tests, you will need access to a local Temporal server, e.g. using the
58+
[Temporal CLI's integrated dev server](https://github.com/temporalio/cli#start-the-server).
59+
2. Install the [Rust toolchain](https://rustup.rs/).
60+
3. Install [Protocol Buffers](https://github.com/protocolbuffers/protobuf/releases/).
61+
4. Clone the [sdk-typescript](https://github.com/temporalio/sdk-typescript) repo:
62+
```sh
63+
git clone https://github.com/temporalio/sdk-typescript.git
64+
cd sdk-typescript
65+
```
66+
5. Initialize the Core SDK submodule:
67+
68+
```sh
69+
git submodule update --init --recursive
70+
```
71+
72+
> If you get a `The authenticity of host 'github.com (192.30.252.123)' can't be established.`
73+
> error, run `ssh-keyscan github.com >> ~/.ssh/known_hosts` and retry.
74+
75+
6. Install the dependencies:
76+
```sh
77+
npm ci
78+
```
79+
This may take a few minutes, as it involves downloading and compiling Rust dependencies.
80+
81+
You should now be able to build:
82+
83+
```sh
84+
npm run build
85+
```
8186

8287
If building fails, resetting your environment may help:
8388

0 commit comments

Comments
 (0)