Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Maintainability Roadmap

Đang mở
#308 2 bình luận 2 reaction 1 người được giao Xem trên GitHub

@mikeharder đang làm issue này rồi.

Từ ngày 21/3/2024.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

A potential roadmap to improve maintainability, ending with the archiving of this repo.

TypeScript

  • Update SwaggerBreakingChanges in openapi-alps to call npm exec --no oad instead of @azure/oad@~0.10.6
  • Move code to azure-rest-api-specs repo, folder eng/tools/openapi-diff
  • Align deps and config with typespec-validation, add to eng/package.json
  • Upgrade all dependencies to latest
    • If some are really difficult we can choose to stay back, but anything older than latest is a liability
  • Remove .NET code from package, replace with call to nuget/dotnet to install and run separate .NET package
  • Existing CLI name oad seems good and short, and aligns with tsv
    • But could rename cli to openapi-diff to be more descriptive
  • Deprecate npm package @azure/oad

.NET

  • Move code to azure-sdk-tools repo, folder tools/openapi-diff
  • Rename to Azure.Sdk.Tools.OpenApiDiff
  • Align deps and config from a similar existing tool, perhaps http-fault-injector
  • Publish nuget package and/or dotnet tool to devops nuget feed (similar to http-fault-injector)
  • Could potentially move code to azure-rest-api-specs, and compile dynamically
    • But it would be the first .NET code in the repo
    • It would add a dependency on .NET SDK (rather than just .NET runtime)

Docs

  • Move docs to azure-rest-api-specs repo

Final

  • Archive this repo (Azure/openapi-diff)
Ngôn ngữ chính
C#
Star
290
Fork
50
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
10

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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/openapi-diff

Tất cả issue của Azure/openapi-diff

Issue tương tự

Thêm issue về C#

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.