Improve the "Making Good PRs" section
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 2.1k
- Forks
- 1k
- Merge medio
- 2 d 12 h
- PR fusionados (30 d)
- 12
Descripción
I often see PRs with misleading or vague titles. This is problematic, as the PR titles often end up being the commit titles, and commit titles are one of the most important tools we have when searching for historic changes. Bad titles impact maintainability.
Suggested edits:
- Enforce a strict title format
- Promote writing accurate and concise PR titles/descriptions
Perhaps the "Making Good PRs" section can be further promoted. Would it make sense to extract it and move it a level up in the doc hierarchy?
Guía de contribución
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.
Línea de trabajo
Comienza localizando la sección "Making Good PRs" en la guía para desarrolladores y revisando la jerarquía de documentación que la rodea. Decide cómo debería abordar la sección los títulos y las descripciones precisos y concisos de los pull requests, y si debería estar en un nivel superior. Se considera completado cuando la guía y su ubicación reflejan claramente las mejoras sugeridas en el issue.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100