Aunque el código existe para ser compilado o ejecutado por un ordenador, también está para que lo lean los humanos. A un ordenador no le importa el aspecto del código mientras sea una sintaxis válida. Sin embargo, hay mucho que puedes hacer en en el formato y estilo del código para hacerlo aún más legible por los humanos.
En su mayoría son cosas simples, como la coherencia en la sangría, espaciado y longitud de línea. Cada idioma tiene sus propias convenciones. proyecto tendrá sus propias especializaciones de esas convenciones. BeeWare no es una excepción.
Someone reviewing a patch still needs to check for correct logic, but these simple style-check tasks are easy to check programatically. Many text editors will (or have extensions that will) do this process for you - the task is called linting. Beefore is a tool that allows you to integrate these checks into your GitHub pre-merge procedure, in the same way that can integrate continuous integration and test suite compliance before merging.
Pero no se limita sólo al estilo del código. Cualquier comprobación objetivamente puede realizarse como parte del procedimiento de antes de la fusión. Por ejemplo:
- Comprobación de un certificado de origen del desarrollador, un acuerdo de licencia del colaborador o cualquier otro procedimiento de licencia de contribución.
- Evaluación de la complejidad del código
- Evaluación de la cobertura del código
y muchos otros.
Beefore se apoya en el proceso de integración continua que usted ya utiliza para ejecutar su conjunto de pruebas antes de fusionar confirmaciones (por ejemplo, Travis-CI). Las pruebas de Beefore se ejecutan como una prueba personalizada.
¿Cómo ayudar?
- Mejora de los linters existentes
- Integración de nuevos linters y controles de estilo (por ejemplo, Java)
Entonces, ¿por qué se llama "Beefore"?
Comprueba todas las cosas que tienes que tener bien antes de fusionar un parche.