Fix .NET SDK prerequisites in CONTRIBUTING.md #87
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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>
TypeScript and tsx are included as npm dependencies and don't need separate installation Co-authored-by: friggeri <106686+friggeri@users.noreply.github.com>
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>
Added "(from the repository root)" to npm install step for clarity Co-authored-by: friggeri <106686+friggeri@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update CONTRIBUTING.md with necessary tweaks for .NET client
Fix .NET SDK prerequisites in CONTRIBUTING.md
Jan 22, 2026
SteveSandersonMS
approved these changes
Jan 22, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the CONTRIBUTING.md documentation to correct prerequisites for the .NET SDK development. The changes clarify that just is optional and document the Node.js dependencies required by the .NET test suite.
Changes:
- Marks the
justcommand runner as optional throughout the document - Adds Node.js v18+ as a prerequisite for .NET SDK development
- Documents npm installation steps for
nodejsandtest/harnessdirectories
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+50
to
+51
| cd nodejs && npm ci | ||
| cd test/harness && npm ci |
There was a problem hiding this comment.
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) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
CONTRIBUTING.md incorrectly stated that
justis required and omitted Node.js dependencies needed by .NET tests.Changes
justas optional (it's a convenience wrapper around direct commands)./nodejsand./test/harnessdirectoriesThe .NET test suite depends on:
nodejs/node_modules/@github/copilot/(referenced inClientTests.cs,E2ETestContext.cs)test/harness/using tsx (started byCapiProxy.cs)Both are installed via
npm ciin their respective directories.Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.