Este proyecto es mantenido por un equipo cerrado, por lo que solo los compañeros del grupo 2 de la materia Sensores y Actuadores podrán realizar contribuciones. Si eres parte del equipo, por favor sigue las siguientes pautas para contribuir al proyecto.
- Cada colaborador debe asignarse una tarea en el repositorio antes de comenzar a trabajar.
- Si la tarea tiene más de un contribuyente, trabajen en una rama separada (branch) asignada específicamente a esa tarea.
- Si la tarea es individual, puedes trabajar directamente en la rama
main.
- Antes de hacer un merge de una rama, verifica que no haya conflictos de código.
- Si hay conflictos, el merge debe ser revisado por al menos 3 participantes para garantizar que no se rompa el código existente.
- Solo realiza el merge si todos los conflictos han sido resueltos de forma correcta.
-
Los commits deben tener una descripción clara y concisa del cambio realizado. Evita mensajes genéricos como "arreglos" o "cambios".
-
Ejemplo de un buen commit:
"Se corrigió el cálculo del sensor de humedad resistivo"
- El código debe ser simple de leer e interpretar.
- Se recomienda usar comentarios para explicar bloques complejos o lógicos importantes.
- La documentación del código no solo es una buena práctica, sino que asegura que el proyecto sea mantenible a largo plazo.
- Siempre que agregues una nueva funcionalidad o realices una modificación significativa, asegúrate de que todo esté documentado y comentado adecuadamente.
- Asegúrate de seguir el estándar de codificación definido para este proyecto (si existe), o mantén un estilo consistente con el código existente.
- La simplicidad y la claridad son primordiales en cada contribución.
Gracias por colaborar con este proyecto. ¡Tu contribución es muy valiosa para el éxito del equipo!