Generated SDK review skill for Java

未关闭
  • 哪里不对？
#51,221 1 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
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 小时
30 天内合并 PR
259

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

Azure/azure-sdk-for-java 的其他 Issue

查看 Azure/azure-sdk-for-java 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。