graphql / graphql/graphql.github.io
Schema Design: Be explicit with descriptions
- Lenguaje dominante
- TypeScript
- Estrellas
- 889
- Forks
- 1.5k
- Merge medio
- 4 d 12 h
- PR fusionados (30 d)
- 21
Descripción
Provide comprehensive context in descriptions, including clear definitions. Avoid team-specific acronyms, describe all enum values, and link to authoritative sources where relevant.
Rationale: Future developers should be able to understand schema elements using only the provided documentation. Include what a concept is, why it matters, where to find additional information, and concrete examples for enum options.
Guía de contribución
Línea de trabajo
Comienza localizando las definiciones del esquema en la base de código graphql.github.io y revisa cómo están redactadas actualmente sus descripciones. Se considera terminado cuando las descripciones proporcionan contexto y definiciones claras, evitan acrónimos específicos del equipo, documentan cada valor del enum, enlazan a fuentes autorizadas cuando corresponda e incluyen el propósito, referencias a información adicional y ejemplos concretos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- graphql, typescript
- Área
- api, documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 48/100