Azure / Azure/azure-sdk-tools

[TypeSpec Authoring] Assess SDK naming conventions

Open
#15,304 0 comments 0 reactions 0 assignees View on GitHub
AzSDK Tools Agent dev inner loop
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 2h
Merged PRs (30d)
130

Description

## Goal

Assess whether names generated from TypeSpec follow Azure SDK naming conventions, with .NET as the primary target.

## Scope

- Review generated SDK client, operation, model, property, parameter, and enum names.
- Prioritize .NET naming conventions, including casing, acronyms, singular/plural forms, and idiomatic public API names.
- Identify the TypeSpec declaration that produces each problematic SDK name.
- Suggest a TypeSpec-level fix when the name should be corrected at the source.
- Avoid reporting subjective preferences that are not supported by SDK guidelines.

## Acceptance criteria

- Naming issues in the generated .NET SDK surface are detected.
- Each finding shows the generated SDK name, the relevant TypeSpec source, and the applicable naming guidance.
- Findings distinguish required convention fixes from optional recommendations.
- Correctly named SDK APIs do not produce findings.

Contributor guide

Open the contributing guide

Research direction

Start by locating the TypeSpec authoring and .NET SDK generation checks that inspect client, operation, model, property, parameter, and enum names. Compare generated names with the applicable Azure SDK naming guidance, then trace each finding to its TypeSpec declaration. Done means required and optional recommendations are distinguished, correctly named APIs produce no findings, and each issue includes the generated name, source declaration, and guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.