Contribuir al código

¿Está pensando en contribuir a Nette Framework y necesita familiarizarse con las reglas y los procedimientos? Esta guía para principiantes le llevará por los pasos necesarios para contribuir código de forma eficaz, trabajar con los repositorios e implementar cambios.

Procedimiento

Para contribuir código es imprescindible tener una cuenta en GitHub y conocer los fundamentos del trabajo con el sistema de control de versiones Git. Si no conoce Git, puede echar un vistazo a git – the simple guide y plantearse usar alguno de los muchos clientes gráficos.

Preparar el entorno y el repositorio

1. En GitHub, cree un fork del repositorio del paquete que se dispone a modificar
2. Clone ese repositorio en su ordenador
3. Instale las dependencias, incluido Nette Tester, con el comando composer install
4. Compruebe que las pruebas funcionan ejecutando composer tester
5. Cree una Rama nueva a partir de la última versión publicada

Implementar sus propios cambios

Ahora puede hacer sus propios ajustes en el código:

1. Implemente los cambios deseados y no se olvide de las pruebas
2. Asegúrese de que las pruebas se ejecutan correctamente con composer tester
3. Compruebe si el código cumple los Estándares de codificación
4. Guarde (commit) los cambios con una descripción en este formato

Puede crear varios commits, uno por cada paso lógico. Cada commit debería tener sentido por sí mismo.

Enviar los cambios

Cuando esté satisfecho con los cambios, puede enviarlos:

1. Suba los cambios a GitHub, a su fork
2. Desde allí, envíelos al repositorio de Nette creando un pull request (PR)
3. Proporcione en la descripción información suficiente

Incorporar los comentarios

Sus commits son ahora visibles para los demás. Es habitual recibir comentarios con sugerencias:

1. Siga los cambios propuestos
2. Incorpórelos como commits nuevos o fusiónelos con los anteriores
3. Vuelva a enviar los commits a GitHub y aparecerán automáticamente en el pull request

Nunca cree un pull request nuevo para modificar uno existente.

Documentación

Si ha cambiado una funcionalidad o ha añadido una nueva, no se olvide de añadirla también a la documentación.

Rama nueva

Si es posible, haga los cambios contra la última versión publicada, es decir, la última etiqueta de la rama. Para la etiqueta v3.2.1, cree una rama con este comando:

git checkout -b nombre_de_la_rama v3.2.1

Estándares de codificación

Su código debe cumplir el estándar de codificación que se usa en Nette Framework. Para comprobar y corregir automáticamente su código, use la herramienta Nette Coding Standard, donde encontrará también las instrucciones de instalación y uso.

Descripción del commit

En Nette, los asuntos de los commits tienen el siguiente formato: Presenter: fixed AJAX detection [Closes #69]

• El área seguida de dos puntos
• El propósito del commit en pasado; si es posible, empiece con palabras como: “added (funcionalidad nueva)”, “fixed (corrección)”, “refactored (cambio de código sin cambio de comportamiento)”, “changed”, “removed”
• Si el commit rompe la retrocompatibilidad, añada “BC break”
• Cualquier enlace al gestor de incidencias, como (#123) o [Closes #69]
• Tras el asunto puede haber una línea en blanco seguida de una descripción más detallada, que incluya, por ejemplo, enlaces al foro

Descripción del pull request

Al crear un pull request, la interfaz de GitHub le permitirá introducir un título y una descripción. Ponga un título conciso e incluya en la descripción toda la información posible sobre los motivos de su cambio.

Indique además en la cabecera si se trata de una funcionalidad nueva o de una corrección de un fallo, y si puede causar problemas de retrocompatibilidad (BC break). Si hay una incidencia relacionada, enlácela para que se cierre al aprobarse el pull request.

- bug fix / new feature?  <!-- #issue numbers, if any -->
- BC break? yes/no
- doc PR: nette/docs#?    <!-- highly welcome, see https://nette.org/en/writing -->