The optional keys of the saved --prs JSON are not documented

Abierto Apto para principiantes
#1,339 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python

Línea de trabajo

Empieza por el docstring del módulo y --help en scripts/check_contributors.py; después, actualiza la fila --prs en CONTRIBUTING.md. Documenta los tipos y usos de commit_authors, closing_issues y files con un ejemplo JSON. Añade o actualiza una prueba para analizar el ejemplo mediante --pending y --stub; la tarea estará terminada cuando la prueba pase y las tres claves estén documentadas.

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

Descripción

community documentation good first issue

Where: scripts/check_contributors.py (module docstring and --help), CONTRIBUTING.md.

Current gap: --prs FILE is documented as gh pr list --state merged --json number,author,mergedAt,title,body, but the stub and pending code also read commit_authors, closing_issues and files per PR (set from gh pr view when the data comes from GitHub), so someone preparing an offline file or a test fixture has to read the source to know.

Suggested approach: List the optional keys, their types and what uses them in the docstring and the CONTRIBUTING row, with one JSON example.

Done when: the three keys are documented and a test parses the documented example through --pending and --stub.

Lenguaje dominante
HTML
Estrellas
47
Forks
45
Merge medio
2 h 39 min
PR fusionados (30 d)
57

Preparar el entorno

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 yakew7/Fair-Code

Todos los issues de yakew7/Fair-Code

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.