PythonBulawayo/ChitChat

Add API Endpoint Documentation

Aperta

#23 aperta il 25 gen 2024

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)TypeScript (24 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (25 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esplora il codebase per identificare tutti gli endpoint API, quindi scegli uno strumento di documentazione come Swagger per documentare ogni endpoint con metodi, parametri ed esempi di risposta.
Tech stack
typescript
Dominio
apidocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75