Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Improve Endpoint Documentation

Aperta
#3 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
fastapi, python
Ambito
api, documentation

Direzione di ricerca

Inizia dalla documentazione dell’API collegata all’indirizzo https://api.leighhack.org/docs e analizza le definizioni degli endpoint FastAPI per identificare ciò che è attualmente documentato. Estendi la documentazione degli endpoint in modo da descrivere lo scopo di ciascun endpoint, quindi verifica che la documentazione pubblicata copra ogni endpoint.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

Documentation is available at https://api.leighhack.org/docs but only has the basics. We need to extend them out to describe what each endpoint does.

Lingua principale
Python
Stelle
0
Fork
0
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di leigh-hackspace/hackspace-api

Tutte le issue di leigh-hackspace/hackspace-api

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.