Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Maintainability Roadmap

Ouverte
#308 2 commentaires 2 réactions 1 personne assignée Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@mikeharder y travaille déjà.

Depuis le 21/3/2024.

Évaluation

Cette issue n'a pas encore été évaluée.

Description

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)
Langage dominant
C#
Étoiles
290
Forks
50
Merge moyen
2 j 10 h
PR mergées (30 j)
12

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de Azure/openapi-diff

Toutes les issues de Azure/openapi-diff

Issues similaires

Plus d'issues C#

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.