Utilizar un estilo coherente
Requisitos
- Las contribuciones DEBEN adherirse a una guía de estilo de código o de escritura, ya sea la propia de la comunidad de la codebase o una existente que se anuncie en la codebase o que forme parte de ella.
- Las contribuciones DEBERÍAN pasar pruebas automáticas de estilo.
- La codebase DEBERÍA incluir comentarios en línea y documentación para las secciones no triviales.
- La guía de estilo PUEDE incluir secciones sobre inglés comprensible.
Por qué es importante
- Permite a los colaboradores de diferentes entornos trabajar juntos en un producto unificado.
- La unificación de vocabularios reduce la fricción en la comunicación entre los colaboradores.
Qué no hace
- Ayudar a los colaboradores a escribir bien o a explicar eficazmente lo que hacen.
Cómo probar o hacer tests
- Verificar si las contribuciones se ajustan a las guías de estilo especificadas en la documentación.
Responsables de políticas y legislaciones: qué necesitan hacer
- Crear, seguir y mejorar continuamente una guía de estilo para las políticas y la documentación, así como documentar la misma codebase, por ejemplo en
CONTRIBUTING
oREADME
.
Profesionales de la dirección de equipos: qué necesitan hacer
- Incluir en la definición de calidad de su organización el lenguaje escrito, las fuentes, las pruebas o tests y las políticas.
Profesionales del desarrollo de software y diseño: qué necesitan hacer
- Crear, seguir y mejorar continuamente una guía de estilo para el código fuente, las pruebas o tests y la documentación, y documéntela en la codebase, por ejemplo, en
CONTRIBUTING
oREADME
. - Utilizar un linter.
- Añadir configuraciones de linter a la codebase.
Más información
- Lista de linters por Hugo Martins.
- Estilo de programación en Wikipedia.