Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Improve Endpoint Documentation

Abierto
#3 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
fastapi, python
Área
api, documentation

Línea de trabajo

Comienza con la documentación de la API enlazada en https://api.leighhack.org/docs e inspecciona las definiciones de los endpoints de FastAPI para identificar qué está documentado actualmente. Amplía la documentación de los endpoints para describir el propósito de cada uno y, después, verifica que la documentación publicada cubra todos los endpoints.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
0
Forks
0
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de leigh-hackspace/hackspace-api

Todos los issues de leigh-hackspace/hackspace-api

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.