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

API Documentation Detail

Abierto
  • ¿Algo no está bien?
#39 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
graphql
Área
api, databases, documentation, testing

Línea de trabajo

Comienza inventariando las áreas de documentación solicitadas: migraciones y volcados de base de datos, convenciones de nomenclatura de db, buildQuery, wrangler.toml y el script del scraper, endpoints REST y GraphQL, y pruebas. Revisa el sitio de documentación existente y las ubicaciones de las páginas de documentación antes de escribir. El trabajo estará terminado cuando el flujo de trabajo documentado cubra los cambios de la base de datos hasta las pruebas de los endpoints, incluidos los códigos de error, ejemplos, archivos modificados y áreas que deben vigilarse.

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

Descripción

DB Design / Changes:

  • db migrations + process of implementation of a new db change + documentation for all moving parts (db dump, process of running migration file on local instance, testing scraper - where to find script)
  • db naming conventions
  • buildQuery

Scraper:

  • documentation on understanding wrangler.toml files, how scrapers work, what to expect from them

Endpoint:

  • error codes and meanings GOOD PRACTICE - along with endpoint info.
  • rest endpoint
    • all files changed
    • areas of focus, things to look out for
    • what a typical change entails
  • graphql
    • difference between rest and graphql
    • example of implementation
    • where to test on docs page
      Testing:
      • testing throughout the process [db change -> endpoint]
Lenguaje dominante
MDX
Estrellas
0
Forks
1
Merge medio
23 d 5 h
PR fusionados (30 d)
1

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 icssc/docs

Todos los issues de icssc/docs

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.