Skip to content

Fix .NET SDK prerequisites in CONTRIBUTING.md #87

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.

Sign up for GitHub

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

Merged
SteveSandersonMS merged 5 commits into from
Jan 22, 2026
Merged

Fix .NET SDK prerequisites in CONTRIBUTING.md #87

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e9aac70
Initial plan
Copilot Jan 22, 2026
394f1d8
Update CONTRIBUTING.md: clarify .NET SDK prerequisites
Copilot Jan 22, 2026
1cb312e
Fix: Remove unnecessary TypeScript installation step
Copilot Jan 22, 2026
9ecf9aa
Fix: Use consistent path navigation from repository root
Copilot Jan 22, 2026
06a5efc
Clarify commands are run from repository root
Copilot Jan 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Currently **we are not looking to add SDKs for other languages**. If you want to
This is a multi-language SDK repository. Install the tools for the SDK(s) you plan to work on:

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

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

### .NET SDK
1. Install [.NET 8.0+](https://dotnet.microsoft.com/download)
1. Install dependencies: `cd dotnet && dotnet restore`
1. Install [Node.js](https://nodejs.org/) (v18+) (the .NET tests depend on a TypeScript-based test harness)
1. Install npm dependencies (from the repository root):
```bash
cd nodejs && npm ci
cd test/harness && npm ci
Comment on lines +50 to +51
Copy link

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These commands won't work correctly when run sequentially. After the first command, you'll be in the nodejs directory, so the second cd test/harness will fail. Each command should either return to the repository root first, or use separate command blocks. Consider changing to:

cd nodejs && npm ci
cd ../test/harness && npm ci

or

(cd nodejs && npm ci)
(cd test/harness && npm ci)
Suggested change
cd nodejs && npm ci
cd test/harness && npm ci
(cd nodejs && npm ci)
(cd test/harness && npm ci)

Copilot uses AI. Check for mistakes.
```
1. Install .NET dependencies: `cd dotnet && dotnet restore`

## Submitting a pull request

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

### Running tests and linters

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

```bash
# All SDKs
Expand Down
Loading