PythonBulawayo/ChitChat

Add API Endpoint Documentation

Ouverte

#23 ouverte le 25 janv. 2024

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)TypeScript (24 forks)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (25 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

The API is currently undocumented. Add documentation to make it easy to build against the API. We should consider using a tool like Swagger to document our endpoints.

Guide contributeur

Direction de recherche
Explorez le codebase pour identifier tous les endpoints de l'API, puis choisissez un outil de documentation comme Swagger pour documenter chaque endpoint avec les méthodes, paramètres et exemples de réponse.
Stack technique
typescript
Domaine
apidocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75