Generated SDK review skill for Java

Aperta
  • Qualcosa non va?
#51,221 1 commento 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
github, github-actions, java
Ambito
developer-experience, tooling

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Java
Stelle
2.6k
Fork
2.2k
Merge medio
1g 17h
PR unite (30g)
259

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Azure/azure-sdk-for-java

Tutte le issue di Azure/azure-sdk-for-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.