Principios para colaborar en Github

Cómo colaborar con los proyectos

Principios para colaborar en Github
Blanco Martín & Asociados

Estas son las bases para comenzar a colaborar en los proyectos.

En la dirección https://github.com/odoo-chile, se pueden encontrar todos los módulos que creemos, son los más convenientes para la localización; odoo-chile es una "organización" de Github, que creamos para compartir los módulos.

Algunos de los desarrollos los hemos tomado como un "fork" de otros.

Para cualquiera que desee colaborar con los desarrollos queremos delinear cuáles son las que proponemos como mejores prácticas para hacerlo.

Seguramente, encontrarás que a los módulos existentes, le faltan características, o que sería muy bueno incorporarle nuevas.

También, es posible encontrar algún error en los desarrollos existentes.

En todos los casos, Github proporciona varias herramientas básicas, que ayudarán a colaborar.

La primera de ella, es el "issue" (incidencia). Cualquier usuario de github, puede generar una incidencia, explicando un problema encontrado en el desarrollo.

El tablero de comando de github, que se encuentra a la derecha de la página principal de cada uno de los repositorios, es el elemento que contiene todos los controles.

Odoo text and image block

Controles Disponibles en el Tablero de Github

Watch o Unwatch: Permite estar notificado/o cambiar ese estado, de cualquier cambio en el repositorio.

Star: Para marcar el proyecto como favorito.

Fork: Te permite duplicar el proyecto en tu propia repositorio de Github. Este es el elemento principal que te ayudará a colaborar, ya que el primer paso para colaborar, es crear tu propio "fork" del proyecto. De esta forma se duplica el proyecto en tu cuenta de Github, sobre la cual tienes los permisos de escribir las modificaciones al proyecto.

Issues: En este lugar podrás colocar las incidencias encontradas en el código. Definamos una incidencia como la vemos nosotros: es un problema manifestado en el código, que indica una deficiencia en el funcionamiento del mismo.

Siendo la localización un proyecto libre, es muy probable que determinadas aplicaciones, o características del desarrollo, puedan ser vistos como incidencias para tí, pero, quizá quien lo desarrolló no vió eso como un problema, y no tiene prioridad en resolver ese supuesto problema. Por lo tanto, si bien nos interesa conocer siempre tu feedback, queremos dejar claro, que la verdadera colaboración en este caso, proviene de explicar el problema y también proveer la solución a dicho problema. Queremos decir con ésto, que la incidencia, debería explicar el problema y también la solución. ¿En qué consiste la solución? Fácil; consiste en escribir el código o modificar el código para RESOLVER el problema planteado.

La sugerencia, es que si encuentras un problema del software y no tienes la capacidad técnica de resolverlo, en primera instancia, las incidencias de Github no son aconsejadas para tí; ese tipo de problema encontrado, es más adecuado para comentarlo en un foro, en donde quizá encuentras a alguien con la capacidad de responder rápidamente y ayudarte a salir adelante, con el inconveniente planteado.

Odoo text and image block

Pasos a seguir en la colaboración:

La mejor forma de colaborar sin necesidad de tener permisos de escritura en los proyectos.

Estos son pasos sencillos para colaborar. Este post no pretende enseñarte a usar Github, ni Git, para lo cual tenemos preparado otro post.

Fork:

Es el primer paso en la colaboración; crear una copia (fork) del proyecto en tu cuenta de github y clonar el proyecto en tu sistema.

Clonar el proyecto en tu sistema y Crear una Rama:

Una vez que has clonado el repositorio en tu computador, puedes crear una rama nueva.

Cambiar tu código y probarlo:

Cuando has creado la rama, puedes hacer modificaciones a tu código.

Subir las modificaciones a tu repositorio de Github (git commit... y git push...)

En el momento de hacer el commit, puedes explicar en qué consistieron tus modificaciones al código. Si es una reparación de un error, es bueno encabezar tu explicación con [FIX] y explicarla.

Pull Request:

Una vez que has subido tu código, puedes entrar a nuestra cuenta de Github, crear un issue (incidencia) explicando el problema encontrado, y a continuación, solicitarnos que unamos nuestro código, con tu rama (mediante un pull request). Esto nos permitirá replicar en el repositorio, las modificaciones que realizaste al código, inclusive mantenerla como la versión principal, o mantenerla en una rama separada, como una versión alternativa del sistema.

Muchos miembros de la comunidad felices con las modificaciones que realizaste al código, y con tu aporte.