Contribución

Requisitos del sistema

Antes de trabajar en Ubiquity, configure su entorno con el siguiente software:

  • Git

  • PHP versión 7.1 o superior.

Obtenga el código fuente de Ubiquity

En Ubiquity repositorio github :

  • Haga clic en Fork proyecto Ubiquity

  • Clona tu fork localmente:

git clone git@github.com:USERNAME/ubiquity.git

Trabaje en su parche

Nota

Antes de empezar, debes saber que todos los parches que vayas a enviar deben publicarse bajo la licencia Apache 2.0, a menos que se especifique explícitamente en tus commits.

Crear un branch temático

Nota

Utilice un nombre descriptivo para su branch:

  • issue_xxx donde xxx es el número de incidencia es una buena convención para las correcciones de errores

  • feature_name es una buena convención para las nuevas funciones

git checkout -b NEW_BRANCH_NAME master

Trabaje en su parche

Trabaja en tu código y haz todas las confirmaciones que quieras, y ten en cuenta lo siguiente:

  • Leer sobre las Normas de codificación de Ubiquity;

  • Añade pruebas unitarias, funcionales o de aceptación para demostrar que el error se ha corregido o que la nueva función funciona realmente;

  • Haga commits atómicos y lógicamente separados (use git rebase para tener un historial limpio y lógico);

  • Escriba buenos mensajes de confirmación (consulte el consejo siguiente).

  • Incrementa los números de versión en cualquier archivo modificado, respetando las reglas de semver:

    Dado un número de versión MAJOR.MINOR.PATCH, incrementa el:

    • versión MAJOR cuando realice cambios incompatibles en la API,

    • versión MINOR cuando añada funciones de forma compatible con versiones anteriores, y

    • versión PATCH cuando realice correcciones de errores compatibles con versiones anteriores.

Envíe su parche

Actualice la parte [Unrelease] del archivo CHANGELOG.md integrando sus cambios en las partes correspondientes:

  • Añadido

  • Cambiado

  • Cambiado

  • Arreglado

Eventualmente, vuelva a basar su parche
Antes de enviar, actualice su rama (necesario si tarda en terminar sus cambios):

git checkout master
git fetch upstream
git merge upstream/master
git checkout NEW_BRANCH_NAME
git rebase master

Hacer una Pull Request

Ahora puede hacer un pull request en Ubiquity repositorio github .