Generated SDK review skill for Java

Đang mở
  • Có gì không ổn?
#51,221 1 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github, github-actions, java
Lĩnh vực
developer-experience, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Java
Star
2.6k
Fork
2.2k
Merge trung bình
1 ngày 17 giờ
Pull request đã merge (30 ngày)
259

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Azure/azure-sdk-for-java

Tất cả issue của Azure/azure-sdk-for-java

Issue tương tự

Thêm issue về Java

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.