Pautas para Código Abierto

Proceso de Desarrollo

Utilizamos un estilo de tablero Kanban para priorizar nuestro trabajo. Por ejemplo, puedes mirar EOS rate project board.

Hemos añadido una columna adicional al diseño automatizado por defecto para mantener una columna To Do priorizada.

Cuando nuevos issues son creados, necesitas usar explícitamente la opción de proyecto en el issue de GitHub para incluirlo en el tablero; una vez que lo haces, el issue quedará automáticamente agregado a la columna de issues nuevos.

Periódicamente movemos los nuevos issues a la columna To Do y manualmente le damos la prioridad apropiada.

Cuando comienzas a trabajar en una tarea, deberías moverla manualmente a la columna In Progress.

Usamos el flujo de GitHub https://guides.github.com/introduction/flow/ para solicitar cambios en el código. Desarrollamos en la rama master y release usando etiquetas y versionamiento.

Los nuevos y reabiertos pull request son autómaticamente añadidos al tablero en la columna En Progreso.

Cuando un pull request cerrado es movido a la columna Done automáticamente. Si el pull request se cierra y no tiene problemas, se indica correctamente con las palabras clave de GitHub que se cierra el pull request y se mueve automáticamente a la columna Done.

Pautas para los Pull Request

• Por favor revisa para asegurarte que no hay ningún pull request existente tratando de localizar o vincular el issue mecionado.
• Busca los issues relacionados en el registro de issues.
• Los cambios no triviales deberían ser discutidos primero en un issue.
• Desarrolla en una rama específica para características (código no estable), nunca en la master: git checkout -b topic-branch.
• Haz amplias y claras descripciones de los pull requests.
• Realiza pull requests atómicos y con un ámbito bien definido. 1 PR por característica o bug.
• Vincula el issue con la descripción pull requestpara referencia entre el código y los issues.

Soportamos únicamente squash merge de los pull requests como una buena práctica para asegurar que el registro de la rama master es mantenido limpio y relevante, sin requerir que el pull request sea modificado. Esta estrategia requiere que todos los pull request sea hechos de forma atómica, en otras palabras, que resuelvan una única cosa. Un pull request por característica, bug o actualizacón de documentación.

Pautas para Mensajes en los Commits

Tenemos reglas muy precisas acerca de cómo los mensajes de los commits de git deben ser formateados. Esto permite mensajes más legibles que son fáciles de seguir cuando se está buscando entre la historia del proyecto. Pero también, usamos los mensajes de commit de git para generar el registro de cambios del proyecto.

Seguimos las convenciones de mensajes de commit como se muestra a continuación:

Formato de Mensaje del Commit

Cada mensaje de commit consiste en un encabezado, un cuerpo y un pié. El encabezado tiene un especial formato que incluye un tipo, un ámbito y un aspecto o tema:

<tipo>(<ambito>): <aspecto>

<BLANK LINE>

<cuerpo>

<BLANK LINE>

<pie>

El encabezado es obligatorio y el ámbito del encabezado es opcional.

Ninguna línea del mensaje de commit puede ser más larga que 100 caracteres. Esto permite que el mensaje sea fácil de leer en GitHub así como también en varias herramientas de git.

El pie debe contener una referencia de cierre de un issue, si hay alguna.

Ejemplos:

docs(changelog): update changelog to beta.5

fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

Más ejemplos aquí

Revertir

Si el commit revierte un commit previo, debe empezar con revert: , seguido por el encabezado del commit revertido. En el cuerpo, debería decir: This reverts commit <hash>, donde el hash is el SHA del commit que está siendo revertido.

Tipo

• build: Cambios que afectan el sistema de operación o dependencias externas (ejemplo scopes: gulp, broccoli, npm)
• ci: Cambios a los scripts y archivos de configuración de CI (ejemplo scopes: Travis, Circle, BrowserStack, SauceLabs)
• docs: Cambios sólo en la documentación
• feat: Una nueva característica
• fix: Un arreglo de un bug
• perf: Cambio en el código que mejora el rendimiento
• refactor: Cambio en el código que no arregla un bug ni añade una característica
• style: Cambios que no afectar en significado del código (espacios en blanco, formato, puntos y comas olvidados, etc)
• test: Añadir pruebas faltantes o corregir las existentes
• content: Añadir o remover contenido
• devtools: Heramientas para desarrolladores

Ámbito

El ámbito es el nombre del componente o servicio que afecta, ejemplo:

• common
• smart-contracts
• webapp
• storage
• graphql
• frontend
• demux
• docker

Aspecto

El aspecto contiene una breve descripción del cambio:

• usa el imperativo, tiempo presente: "cambio" no "cambiado" ni "cambios"
• no pongas la primera letra en mayúscula
• no añadas (.) al final

Cuerpo

Justo como en el aspecto, usa el imperativo, tiempo presente: "cambio" no "cambiado" ni "cambios". El cuerpo debe incluir la motivación para el cambio y contrastar esto con el comportamiento anterior.

Pié

El pié debe contender cualquier información acerca de los cambios importantes con repercusiones (breaking changes) y es también el lugar para referenciar los issues que el commit cierra.

Los Breaking Changes deben empezar con la palabraBREAKING CHANGE: con un espacio o dos nuevas líneas. El resto del mensaje de commit es luego usado para esto.

Reportar bugs

Antes de subir tu issue por favor revisa que has completado los siguientes pasos:

• Asegúrate de estar en la última versión.
• Usa la funcionalidad de búsqueda para asegurarte de que el bug no ha sido reportado aún.

Los reportes de bug deben contener la siguiente información:

• Summary: Una breve descripción.
• Steps to reproduce: ¿Cómo encontraste el bug? Instrucciones para reproducirlo.
• Expected behavior: ¿Cómo esperas que se comporte?
• Actual behavior: ¿Cómo se comporta actualmente?
• References: Vínculos a cualquier tag o recursos de información.
• Si es posible, añadie información visual del bug. Una captura de pantalla o un gif.

Lanzamientos

Lanzamos el software para producción usando las etiquetas de GitHub Semver, excepto que la versión tiene nombres semánticos, por ejemplo "Breaking.Feature.Fix" en lugar de "Major.Minor.Patch".

Breaking.Feature.Fix

No decidimos cuál será la versión. Los cambios en el API deciden. Los números en la versión son para computadoras, no para personas. Los nombres en los lazamientos son para las personas.

Breaking

Cualquier "breaking change", no importa cuán pequeño, incrementa el número de la versión. Incrementar la versión no tiene relación con emitir un lanzamiento.

Característica (Feature)

Cuando una nueva característica es añadida, esto puede ser tan pequeña como propiedad pública, o tan larga como módulo siendo expuesto.

Fix

Cuando una característica documentada no se comporta como está documentada, o cuando un problema de seguridad es descubierto y arreglado sin alterar el comportamiento documentado.

Generación de Registro de Cambios

En cada nuevo lanzamiento, generamos un archivo de registro de cambios usando el estándar git-changelog. Hay una tarea de npm para esto.

Herramientas de Git Avanzadas

Hay también herramientas como Hub y git-extras que facilitan la interacción con GitHub. Puedes aprovechar estas herramientas para contribuir a este repositorio.

Estándares de Código

Usamos standardjs code style.

Integración Continua y Entrega

Esto es un trabajo en progeso, problamente usaremos Netlify y TravisCI.

Pre-commit Hooks

Usamos los pre-commit hooks para asegurarnos que los estándares de código y las convenciones de mensajes son cumplidas.