¿Cómo contribuir?
Bienvenido a la Comunidad de Onesait Platform
Como proyecto de código abierto, onesait Platform está esperando sus contribuciones. Puedes contribuir a la Comunidad de varias maneras.
¿Qué te conviene más?
- Quiero hacer algunos ejemplos en la plataforma y quiero que estos ejemplos sean parte de la plataforma.
- Me gustaría mejorar vuestra documentación o crear nuevas guías.
- He encontrado algunos bug. ¿Qué hago?
- He encontrado un bug, tengo el código fuente y lo he resuelto.
- Creo que necesitáis más pruebas. Tengo tiempo y quiero ayudar.
- Me encantaría mejorar uno de los módulos o componentes.
- Necesito una funcionalidad no cubierta por la plataforma pero creo que puedo desarrollarla como un módulo o extensión en la plataforma.
- Tengo un caso de negocio (o idea) y creo que puedo hacerlo con la plataforma. ¿Me ayudáis?
Estamos siguiendo el estándar de código abierto para la colaboración, así que:
Siéntete libre de contribuir a nuestro repositorio en GitHub
Para contribuir al proyecto en GitHub, sigue leyendo.
Pero si crees que es mejor hablar con nosotros
Para ver cómo enfocar tu contribución, escribe a nuestro correo electrónico contributions@onesaitplatform.com
Cómo contribuir en Github
Para contribuir al proyecto en GitHub, usa el GitHub flow (flujo de GitHub). Significa que debes ramificar desde el repositorio principal y contribuir haciendo Pull Requests. (Ése es un flujo de proceso generalmente aceptado en GitHub).
Para seguir las instrucciones de esta guía y comenzar a contribuir al proyecto onesait Platform en GitHub:
- Haz un Fork al repositorio principal.
Sobre https://github.com/onesaitplatform/onesait-cloud-platform, selecciona:
- Clona tu nuevo repositorio.
Para eso, ejecuta el siguiente comando.
git clone https://github.com/<your_github_name>/onesait-cloud-platform # Replace <your_github_name> with your GitHub profile name.
cd onesait-cloud-platform
3. Para sincronizar con el repositorio principal, añádelo a los remotos:
git remote add upstream https://github.com/onesaitplatform/onesait-cloud-platform.git
Ahora tu upstream apunta a onesaitplatform/onesait-cloud-tplatform.
Ramas
La rama master (maestra) representa la última versión de desarrollo de onesait Platform.
La mayoría de los cambios deberían ir ahí.
Las ramas release-x.x se usan como ramas estabilizadoras para las releases de mantenimiento.
Si quieres hacer un backport para arreglar un error, abre tu Pull Request (PR) contra la rama release apropiada.
"Mergear" requisitos
Resuelve cualquier conflicto de "mergeo" que pueda surgir. Si se produce un conflicto, se mostrará un mensaje correspondiente en la página de PR de GitHub.
Para resolver un conflicto, ejecuta los siguientes comandos:
# checkout a branch you open PR from
git fetch upstream # assuming upstream is onesaitplatform/onesait-cloud-platform.
git merge upstream/merge_branch # Where merge_branch is a branch you open PR against.
# resolve pull requests
git add *
git commit
git push
GitHub actualizará automáticamente tu pull request.
Prueba
Todas las pull requests se probarán automáticamente con Jenkins. Si algunas pruebas fallan, debes arreglar los problemas o describir por qué no se pueden arreglar.
Revisa
Los miembros del equipo asignado revisan cada pull request extracción según el procedimiento estándar de GitHub. Los revisores pueden comentar un Pull Reuest, aprobarlo o solicitar cambios sobre él. Un PR puede ser mergeado cuando es aprobado por al menos dos revisores asignados y no tiene solicitudes de cambios pendientes.
Gatekeepers
Un gatekeeper o guardián es una persona responsable de la revisión final y mergeo. También son responsables de gestionar los repositorios de Git. Sólo los guardianes pueden escribir en el maestro y en las ramas release.