Generated SDK review skill for Java

オープン
  • 何か問題がありますか？
#51,221 コメント 1 件 リアクション 1 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
github, github-actions, java
領域
developer-experience, tooling

調査の方向性

Start by reading the parent issue Azure/azure-rest-api-specs#48167 and the shared contract in Azure/azure-rest-api-specs#48168, then inspect this repository’s existing skill and CI conventions. The issue leaves skill names, supported planes, pilot packages, historical examples, maintainers, and CODEOWNERS paths to be decided by the language team. Done means both owned skills meet the shared contract, reviewed evals pass in CI, and supported planes and pilot packages are documented.

索引モデルが issue の本文から書いたものです。

説明

needs-triage

Parent: https://github.com/Azure/azure-rest-api-specs/issues/48167
Repository: Azure/azure-sdk-for-java
Related: #51237 (TypeSpec remediation skill, depends on this issue)

Language-team ownership

  • Language owner completing this issue:
  • Review skill maintainers:
  • CODEOWNERS paths or team: <paths/team>

The language owners confirm supported planes and package types, pilot packages, and maintainers.

Summary

Author and maintain a generated SDK review skill that the central spec-PR pipeline invokes on the generated Java package. It reports high-confidence API design problems while the spec PR is still open.

A completed review skill is a checkpoint on its own. It can be integrated before the remediation skill in #51237 is ready.

The pipeline never edits the spec PR or the SDK repo.

Shared skill contract

The central invocation, input, output, and trusted-validation contracts are defined in Azure/azure-rest-api-specs#48168.

The language team owns the skill's internal design, rules, supporting tools, and review methodology. Central integration requires only that the skill satisfies the shared review contract within the provided read-only execution environment.

Deliverable: Generated SDK review skill

Location: .github/skills/<review-skill-name>/SKILL.md

  • Declares the supported management-plane and data-plane package types.
  • Accepts the reconstructed SDK workspace and immutable review context supplied by the central workflow.
  • Returns the versioned generated SDK review result defined in Azure/azure-rest-api-specs#48168.
  • Works within the provided read-only execution environment.

Evidence and evals

  • A small set of historical spec or SDK PRs with known review findings.
  • Examples for every plane declared supported; unsupported planes are documented with gaps and follow-up ownership.
  • Evals confirm that the skill finds the important known problems without incorrect or duplicate findings.
  • Evals run in CI in this repository.
  • Evidence links and expected outcomes are reviewed by the language-team maintainers.

Pilot packages

Plane Package Evidence
Management <tsp-location.yaml, customizations>
Data <...>

Use not yet supported with a linked gap and owner when a plane is not ready. Do not select a pilot merely to fill both rows.

Maintenance

  • Named maintainers for the review skill (added to CODEOWNERS for the skill folder).
  • Process for updating the skill as the language team's review guidance or emitter behavior changes.

Completion criteria

  • The skill path is final and owned by the language team.
  • The skill satisfies the shared review contract in Azure/azure-rest-api-specs#48168.
  • Supported and unsupported planes and package types are documented.
  • Historical examples and evals are reviewed and passing.
  • Pilot packages are identified for each supported plane.
  • Maintainers and CODEOWNERS are confirmed.
  • The language team confirms the skill is ready for central generated SDK review integration.

Out of scope

TypeSpec remediation (tracked in #51237), central workflow implementation, PR publication, blocking checks, applying fixes, and regeneration.

主要言語
Java
スター
2.6k
フォーク
2.2k
平均マージ
1日 17時間
マージ済み PR（30日）
259

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Azure/azure-sdk-for-java のほかの issue

Azure/azure-sdk-for-java の issue をすべて見る

似ている issue

Java の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。