📘 CONTRIBUTING.md

(Guía oficial de contribución al ecosistema LINCAT / CNC‑CAT)

Contribuir al proyecto LINCAT / CNC‑CAT

Gracias por tu interés en contribuir. Este proyecto sigue estándares industriales y una arquitectura modular clara. Para mantener la calidad, todas las contribuciones deben seguir estas reglas.

⭐ 1. Requisitos previos

• Conocimientos básicos de Python

• Familiaridad con Qt6 (UI LINCAT)

• Conocimientos de arquitectura modular

• Entender la Motion API

• Conocer el flujo CNC → Planner → Interpolador

• Conocer EtherCAT (opcional pero recomendado)

⭐ 2. Flujo de trabajo

1. Crear un fork del repositorio

2. Crear una rama nueva

   • feature/nombre\_funcionalidad

   • fix/nombre\_bug

3. Realizar cambios siguiendo CODE_STYLE.md

4. Ejecutar pruebas (si existen)

5. Actualizar documentación si es necesario

6. Crear un Pull Request

7. Esperar revisión

⭐ 3. Tipos de contribuciones aceptadas

• Nuevos módulos

• Mejoras en UI LINCAT

• Mejoras en Motion API

• Nuevos drivers

• Mejoras en EtherCAT Layer

• Mejoras en PLC integrado

• Correcciones de bugs

• Mejoras de documentación

• Diagramas UML

• Scripts de utilidad

⭐ 4. Estándares de commits

Usar formato:

Código

`tipo: descripción corta`


`Descripción larga opcional.`

Tipos:

• feat: nueva funcionalidad

• fix: corrección

• docs: documentación

• refactor: cambio interno

• style: formato

• test: pruebas

• perf: rendimiento

Ejemplo:

Código

`feat: añadir soporte para homing incremental`

⭐ 5. Reglas para Pull Requests

• Deben ser pequeños y enfocados

• Deben incluir descripción clara

• Deben pasar pruebas

• Deben seguir CODE_STYLE.md

• Deben actualizar documentación si aplica

⭐ 6. Comunicación

• Issues para bugs

• Discussions para ideas

• PRs para cambios concretos

⭐ 7. Licencia

Todas las contribuciones se integran bajo la licencia libre del proyecto