Skip to content

docs: fix stale version requirements and add Rust/Java sections to CONTRIBUTING.md #2247

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

Open
rinceyuan wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −2
Open

docs: fix stale version requirements and add Rust/Java sections to CONTRIBUTING.md #2247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 19 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ This is a multi-language SDK repository. Install the tools for the SDK(s) you pl

### Node.js/TypeScript SDK

1. Install [Node.js](https://nodejs.org/) (v18+)
1. Install [Node.js](https://nodejs.org/) (v20.19+ or v22.12+)
1. Install dependencies: `cd nodejs && npm ci`

### Python SDK

1. Install [Python 3.8+](https://www.python.org/downloads/)
1. Install [Python 3.11+](https://www.python.org/downloads/)
1. Install [uv](https://github.com/astral-sh/uv)
1. Install dependencies: `cd python && uv pip install -e . --group dev`

Expand All @@ -63,6 +63,17 @@ This is a multi-language SDK repository. Install the tools for the SDK(s) you pl
1. Install [.NET SDK 10+](https://dotnet.microsoft.com/download)
1. Install .NET dependencies: `cd dotnet && dotnet restore`

### Rust SDK

1. Install [Rust](https://www.rust-lang.org/tools/install) (latest stable)
1. Build: `cd rust && cargo build`

### Java SDK

1. Install [JDK 17+](https://adoptium.net/) (JDK 25+ for the full multi-release build)
1. Install [Maven](https://maven.apache.org/download.cgi)
1. Build: `cd java && mvn compile`

## Submitting a Pull Request

1. Fork and clone the repository
Expand All @@ -88,6 +99,12 @@ cd go && go test ./... && golangci-lint run ./...

# .NET
cd dotnet && dotnet test test/GitHub.Copilot.SDK.Test.csproj

# Rust
cd rust && cargo test

# Java
cd java && mvn test
```

Here are a few things you can do that will increase the likelihood of your pull request being accepted:
Expand Down