Utilizamos git para el control de versiones junto con Github
Los mensajes de los commit están basados en Conventional Commits y deben ser de la siguiente forma:
- Siempre en inglés
- Normalmente tienen una sola línea
- Parten con la forma de: tipo, un contexto y una descripción
tipo(contexto): descripción
Los tipos nos ayudan a clasificar los commits y a hacer más fácil la búsqueda en caso de que algo salga mal. Los tipos más usados en iOLED son:
- feature: Nueva feature
- fix: La correción de un bug
- doc: Cambios en la documentación
- style: Cambios en el estilo
- refactor: Cambios en el código que no agrega una funcionalidad ni corrige un bug
El contexto hace referencia al lugar del código o funcionalidad que afecta el commit. Se escribe usando kebab-case.
- sin punto (.) al final
- sin mayuscula al principio
Como ejemplo de estas recomendaciones el siguiente commit soluciona un bug en el método applyLedConfig en el firmware del LED, en el cual no se estaba apagando el LED al aplicar porcentaje 0.
fix(applyLedConfig): fix problem when set percent in 0
The 'applyLedConfig' method don't turn off the LED when set percent in 0.
This commits add validation when set percent in 0.
Los fatures se hacen en un nuevo branch y hacemos un pull request hacia develop.