Azure / Azure/azure-sdk-tools

[TypeSpec Authoring] Support brownfield service cases

Open
#15,535 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 1h
Merged PRs (30d)
143

Description

## Overview

Brownfield services may have some existing patterns that not fully compliant with azure guidelines. Especially dataplane service, like search.

To make the skill broadly useful to first-party Azure service teams, we want to extend it (and its evaluation suite) to cover brownfield service authoring cases.

## Possible solutions

- let service team use their customized skill to write typespec, but can use our assessment skill to assess the code and decide whether to apply fix. related [issue](https://github.com/Azure/azure-sdk-tools/issues/14529)
- we support architecture to let service team easily plugin their document to customize generated code, related [issue](https://github.com/Azure/azure-sdk-tools/issues/15131)

## Documents
https://gist.github.com/xiangyan99/808fdf79f0973ef94962402b105d0028

Contributor guide

Open the contributing guide

Research direction

Start by reading the linked gist and related issues 14529 and 15131 to understand the proposed brownfield authoring approaches. Then locate the authoring skill and evaluation suite in the repository; the issue is complete when one supported approach and its assessment or customization behavior are defined and covered by evaluation cases.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.