Desarrollo#

Angie es un proyecto de código abierto que da la bienvenida a todos los colaboradores.

Código fuente#

Puedes clonar el código fuente de Angie desde nuestros repositorios públicos: Mercurial, Git.

Estilo de codificación#

Tus cambios deben ser consistentes con el resto del código de Angie; las convenciones de codificación son un buen punto de partida.

Truco

En caso de duda, examina el código cercano para seguir su ejemplo, o simplemente usa grep en la base de código para inspirarte.

Mensajes de commit#

Históricamente, el registro de commits se mantiene en inglés.

Comienza con un resumen de una sola línea de lo que se hizo. Puede llevar un prefijo que el registro de commits use para la parte de código afectada. El resumen puede tener hasta 67 caracteres y puede ir seguido de una línea en blanco y más detalles.

Un buen mensaje indica qué causó el cambio, qué se hizo al respecto, y cuál es la situación ahora:

API: bad things removed, good things added.

As explained elsewhere[1], the original API was bad because stuff;
this change was introduced to improve that aspect locally.

Levels of goodness have been implemented to mitigate the badness;
this is now the preferred way to work.  Also, the badness is gone.

[1] https://example.com

Detalles que pueden pasar desapercibidos:

  • El resumen termina con un punto y empieza con una letra mayúscula.

  • Si se usa un prefijo, éste va seguido de una letra minúscula.

  • Dos espacios en blanco separan oraciones dentro de una misma línea.

Verificaciones finales#

  • Haz todo lo posible para verificar que los cambios funcionen en todas las plataformas de destino.

  • Para cada plataforma, ejecuta la suite de pruebas para asegurarte de que no haya regresiones:

    $ cd tests
$ prove .

    Consulta el archivo tests/README para obtener detalles.

  • Asegúrate de estar cómodo con los términos legales.

Envío de contribuciones#

Para enviar un parche, crea una pull request en nuestro espejo de GitHub.

Para preguntas y sugerencias, ponte en contacto con los desarrolladores a través de Issues de GitHub.