Improving code formatting docs with additional efficiency recommendations
Abierto
Nadie ha tomado este issue todavía.
help wanted
- Lenguaje dominante
- C++
- Estrellas
- 74
- Forks
- 9
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
node-cpp-skel has support for:
- a
.clang-formatstyle file that provides formatting rules (which can be modified/customized) make formatan easy command to run to consistently format all the code (and ensure a consistent version of clang-format is available)- a travis job that runs a check to catch when you've forgotten to format your code and in contains incorrectly formatted code (uses same clang-format version as is used locally by
make format)
We can improve by adding docs/recommendations for developers for how to:
- add a git commit hook to ensure code is formatted (before pushing) - refs http://www.duskborn.com/git-pre-commit-clang-format-hook/
- integrate the mason installed clang-format with common text editors such that formatting happens during coding (like seen in https://youtu.be/uZI_Qla4pNA?t=1904)
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
Localiza la documentación que cubre .clang-format, make format y la comprobación de formato de Travis. Revisa la referencia enlazada sobre el pre-commit hook y el vídeo sobre la integración con editores, y añade recomendaciones para ambos flujos de trabajo. Se considerará terminado cuando los desarrolladores puedan encontrar instrucciones prácticas para configurar un hook de formateo y configurar editores habituales para usar el clang-format instalado por Mason.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- cpp
- Área
- documentation, tooling
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- Medio día
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100