Skip to content

Latest commit

 

History

History
138 lines (88 loc) · 5.11 KB

how_to_collaborate.md

File metadata and controls

138 lines (88 loc) · 5.11 KB

Cómo colaborar en el proyecto

Requisitos

  1. Disponer de una cuenta de GitHub
  2. Solicitar invitación como colaborador vía mail
  3. Aceptar la invitación como colaborador

Es recomendable realizar la conexión a través de SSH

Configuración

  1. Instalar Odoodock. Para ello hay que seguir los pasos indicados aquí hasta el paso 8.

  2. Modificar el .env para configurar los siguente valores:

      ODOO_VERSION=14
  ODOO_INSTALL_NANO=true
  ODOO_INSTALL_SSH=true
  ODOO_INSTALL_GIT=true
  ODOO_INSTALL_SSL_DEV=true
  ODOO_INSTALL_PDFTK=true

  3. Modificar el .services descomentando el servicio moodle.

  4. Continuar la instalación de Odoodock hasta el final.

  5. Clonar el repo de Atenea desde github. Para ello la mejor opción es el uso de script create-module.sh, opción O2, tal y como se explica aquí

    $ ./create-module.sh -g https://github.com/aoltra/atenea.git

  6. Instalar los paquetes Python necesarios. Para ello, desde odoodock ejecutar:

    $ docker exec -it odoodock-web-1 bash
> cd /mnt/extra-addons/atenea
> pip3 install -r requirements-dev.txt

    Aunque dependiendo del sistema puede no ser necesario, es aconsejable reiniciar los servicios (al menos el web):

    $ docker compose down
$ ./up.sh

  7. Para comprobar que todo ha ido correctamente, acceder desde un navegador a localhost:8069, configurar los datos del sistema (Base de datos, usuario administrador y contraseña) y posteriormente instalar el módulo Atenea.

    Nota: En caso de que el módulo no aparezca en el listado de aplicaciones, hay que actualizar la lista de aplicaciones. Para ello es necesario tener activo el modo desarrollador (la opción más sencilla es usando una extensión para Firefox o Chrome)

TODO: aula moodle, contraseñas usuarios, key moodle, modificacion odoo.conf, ajuste id aulas y tareas, configuracion correo, creación de usuarios

Cómo trabajar

Para cada una de las tareas a realizar hay que crearse un rama, en la que irán todos los commits relacionados con esa tarea/desarrollo.

  1. Poner al día dev. Desde la rama dev

    > git pull origin dev

  2. Desde dev crear una rama y posicionarse en ella para el desarrollo del código. La rama tendrá como nomenclatura:

    tipo_módulo_descripción

    Dónde:

    • tipo: cualquiera de los tipos descritos en commit_spec
    • módulo: cualquiera de los contextos descritos en commit_spec
    • descripción: nombre de la característica o número de issue

    Por ejemplo, desde la rama dev:

    > git checkout -b fix_core_34

    No todos los commits de ese desarrollo tienen porque ser del mismo tipo que la rama

  3. Crear todos los commits necesarios en local.

Pull Request

Una vez finalizada la tarea hay que solicitar un pull request para que el código se incluya en la rama dev del repo.

  1. Hacer un push de la rama a origin

    > git push origin fix_core_34

  2. Cuando la tarea esté acabada, desde Github, hacer un pull request, documentándolo correctamente para que el revisor tenga toda la información. El PR se hace sobre la rama dev y hay que rellenar los datos sobre revisor, a quién está asignado y si está vinculado a una tarea del proyecto o issue

  3. El revisor aprueba, comenta o requerirá cambios.

Consejos

  • Hacer commits concretos y con mensajes claros (ver commit_spec).

  • Duración de la ramas cortas en el tiempo. Si una característica es muy larga es preferible dividirla en subcaracterísticas.

  • Poner al día dev antes de empezar.

  • Para solucionar posibles conflictos de la manera más sencilla, es conveniente antes de hacer el push de la rama, hacer un pull de dev a la rama de trabajo

    > git pull origin dev

  • Aunque no es lo habitual, si varios programadores trabajan en la misma tarea, es decir, en la misma rama, es conveniente poner también al día esa rama (puede exigir la resolución de conflictos)

> git pull origin fix_core_34

Cómo testear el PR

Para testear y aprobar el código del PR, los pasos son:

  1. Obtener la pseudo-rama del PR y darle un nombre de rama local, por ejemplo pr20:

    > git fetch origin pull/20/head:pr20

  2. Posicionarse en esa rama

    > git checkout pr20

  3. Hacer las pruebas

En caso que querer modificar el código del PR, se pueden realizar todos los commits que se consideren y posteriormente subirlos

> git pull upstream pull/20/head