Skip to content

Commit 5346a78

Browse files
Copilotedburns
andauthored
Add Rust to SDK consistency review workflow guidance
Co-authored-by: edburns <75821+edburns@users.noreply.github.com>
1 parent ce83c78 commit 5346a78

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

.github/workflows/sdk-consistency-review.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ on:
1111
- 'go/**'
1212
- 'dotnet/**'
1313
- 'java/**'
14+
- 'rust/**'
1415
workflow_dispatch:
1516
inputs:
1617
pr_number:
@@ -36,7 +37,7 @@ timeout-minutes: 15
3637

3738
# SDK Consistency Review Agent
3839

39-
You are an AI code reviewer specialized in ensuring consistency across multi-language SDK implementations. This repository contains five SDK implementations (Node.js/TypeScript, Python, Go, .NET, and Java) that should maintain feature parity and consistent API design.
40+
You are an AI code reviewer specialized in ensuring consistency across multi-language SDK implementations. This repository contains six SDK implementations (Node.js/TypeScript, Python, Go, .NET, Java, and Rust) that should maintain feature parity and consistent API design.
4041

4142
## Your Task
4243

@@ -71,6 +72,7 @@ When a pull request modifies any SDK client code, review it to ensure:
7172
- **Go**: `go/`
7273
- **.NET**: `dotnet/src/`
7374
- **Java**: `java/src/main/java/`
75+
- **Rust**: `rust/src/`
7476

7577
## Review Process
7678

@@ -93,6 +95,7 @@ When a pull request modifies any SDK client code, review it to ensure:
9395
- Go uses PascalCase for exported/public functions (e.g., `CreateSession`) and camelCase for unexported/private functions
9496
- .NET uses PascalCase (e.g., `CreateSession`)
9597
- Java uses camelCase for methods (e.g., `createSession`) and PascalCase for classes
98+
- Rust uses snake_case for functions and methods (e.g., `create_session`) and PascalCase for types
9699
- Focus on public API methods when comparing across languages
97100
3. **Focus on API surface**: Prioritize public APIs over internal implementation details
98101
4. **Distinguish between bugs and features**:
@@ -105,7 +108,7 @@ When a pull request modifies any SDK client code, review it to ensure:
105108
## Example Scenarios
106109

107110
### Good: Consistent feature addition
108-
If a PR adds a new `setTimeout` option to the Node.js SDK and the equivalent feature already exists or is added to Python, Go, and .NET in the same PR.
111+
If a PR adds a new `setTimeout` option to the Node.js SDK and the equivalent feature already exists or is added to Python, Go, .NET, Java, and Rust in the same PR.
109112

110113
### Bad: Inconsistent feature
111114
If a PR adds a `withRetry` method to only the Python SDK, but this functionality doesn't exist in other SDKs and would be useful everywhere.

0 commit comments

Comments
 (0)