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

Docs on the CLI or the JS API?

Ouverte
#348 0 commentaires 3 réactions 0 personnes assignées Voir sur GitHub

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

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Documentation
Clarté
À clarifier
Activité
À l'abandon
Stack technique
javascript
Domaine
api, cli, documentation

Piste de recherche

L’issue mentionne CLI, JS API et JSDocs comme points d’entrée à examiner ; commencez par vérifier s’il existe une documentation publique pour chacun d’eux. Pour considérer le travail comme terminé, il faudrait convenir d’un périmètre de documentation ou d’un processus de génération couvrant les interfaces demandées sans ajouter une charge de maintenance mal définie.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Hi there! I just stumbled upon this library recently and it looks excellent — are there any public-facing docs on the CLI or the JS API?

If you're accepting external contributors for documentation, let me know. I'd be happy to at least help set up some sort of doc generation process (e.g., based on the JSDocs) — I want to be mindful of not adding on to the maintenance burden 🙂 thanks!

Langage dominant
C#
Étoiles
290
Forks
50
Merge moyen
2 j 21 h
PR mergées (30 j)
10

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.