realpython / realpython/python-guide
Recommend pre-commit in Code Style section
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Batchfile
- Estrellas
- 29.8k
- Forks
- 5.9k
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
The Code Style section discusses the use of PEP8 and autopep8. Yelp's pre-commit framework allows you to formalise the use of PEP8 in a project by ensuring that PEP8/PyFlakes is run on Python code (as well as equivalent tools for other languages like JSHint). Pre-commit is not mandatory: it is something which individual developers on a project can install if they feel like it - the pre-commit framework simply allows you to share around a common set of pre-commit scripts in a sensible way.
If it is desirable to follow "Pythonicity" in a project, it is probably a good idea to suggest people enforce it at the level of version control.
If there's interest in this, I can draft some text for inclusion and submit a PR.
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 con la sección Code Style, especialmente con su explicación de PEP8 y autopep8, y revisa cómo presenta actualmente la guía las herramientas de estilo. La tarea estará terminada cuando la sección cubra claramente la recomendación propuesta para pre-commit y su carácter opcional, y las indicaciones existentes sigan siendo coherentes.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Á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