Skip to content

Commit 1f06cf5

Browse files
Copilotfriggeri
andauthored
Fix .NET SDK prerequisites in CONTRIBUTING.md (#87)
* Initial plan * Update CONTRIBUTING.md: clarify .NET SDK prerequisites - Mark 'just' as optional since commands can be run directly - Add Node.js and TypeScript as requirements for .NET SDK (needed for test harness) - Add npm install instructions for ./nodejs and ./test/harness directories - Update "Running tests and linters" section to clarify 'just' is optional Co-authored-by: friggeri <106686+friggeri@users.noreply.github.com> * Fix: Remove unnecessary TypeScript installation step TypeScript and tsx are included as npm dependencies and don't need separate installation Co-authored-by: friggeri <106686+friggeri@users.noreply.github.com> * Fix: Use consistent path navigation from repository root Changed from relative path (cd ../test/harness) to absolute path from repo root (cd test/harness) for consistency Co-authored-by: friggeri <106686+friggeri@users.noreply.github.com> * Clarify commands are run from repository root Added "(from the repository root)" to npm install step for clarity Co-authored-by: friggeri <106686+friggeri@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: friggeri <106686+friggeri@users.noreply.github.com>
1 parent 2c3ceb4 commit 1f06cf5

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Currently **we are not looking to add SDKs for other languages**. If you want to
2626
This is a multi-language SDK repository. Install the tools for the SDK(s) you plan to work on:
2727

2828
### All SDKs
29-
1. Install [just](https://github.com/casey/just) command runner
29+
1. (Optional) Install [just](https://github.com/casey/just) command runner for convenience
3030

3131
### Node.js/TypeScript SDK
3232
1. Install [Node.js](https://nodejs.org/) (v18+)
@@ -44,7 +44,13 @@ This is a multi-language SDK repository. Install the tools for the SDK(s) you pl
4444

4545
### .NET SDK
4646
1. Install [.NET 8.0+](https://dotnet.microsoft.com/download)
47-
1. Install dependencies: `cd dotnet && dotnet restore`
47+
1. Install [Node.js](https://nodejs.org/) (v18+) (the .NET tests depend on a TypeScript-based test harness)
48+
1. Install npm dependencies (from the repository root):
49+
```bash
50+
cd nodejs && npm ci
51+
cd test/harness && npm ci
52+
```
53+
1. Install .NET dependencies: `cd dotnet && dotnet restore`
4854

4955
## Submitting a pull request
5056

@@ -59,7 +65,7 @@ This is a multi-language SDK repository. Install the tools for the SDK(s) you pl
5965

6066
### Running tests and linters
6167

62-
Use `just` to run tests and linters across all SDKs or for specific languages:
68+
If you installed `just`, you can use it to run tests and linters across all SDKs or for specific languages:
6369

6470
```bash
6571
# All SDKs

0 commit comments

Comments
 (0)