PythonBulawayo/ChitChat

Add API Endpoint Documentation

Offen

#23 geöffnet am 25.01.2024

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (24 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (25 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Erkunden Sie die Codebasis, um alle API Endpunkte zu identifizieren, wählen Sie dann ein Dokumentationstool wie Swagger aus, um jeden Endpunkt mit Methoden, Parametern und Antwortbeispielen zu dokumentieren.
Tech Stack
typescript
Domain
apidocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75