The optional keys of the saved --prs JSON are not documented
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
- Área
- documentation
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
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
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de yakew7/Fair-Code
-
enhancement good first issue tooling
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
ci enhancement testing
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
enhancement good first issue reproducibility
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
enhancement good first issue testing
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
ci enhancement tooling
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
Todos los issues de yakew7/Fair-Code
Issues similares
-
review-followup
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
griffinwork40/agent-afk#5180 ·
Los mantenedores suelen responder en 1 día
-
APIs documentation Nodes Security
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Adamant-im/docs#46 ·
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 76/100
416rehman/Guardrails#1716 ·
-
Ep2: source of metadata?Abierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
-
Document the service-mesh L7 authorization boundary: non-enrolled workloads and shared rulesAbiertoarea:kubernetes area:security documentation priority:medium size:small
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
RonaldHensbergen/composable-data-stack#1339 ·
Los mantenedores suelen responder en 1 día