Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (48 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

69 lines (48 loc) · 2.66 KB
Raw

Cómo contribuir a BrosLMV

¡Gracias por tu interés! BrosLMV es software libre bajo GPL-3.0. La meta del proyecto es un motor de botones para CONTPAQi Comercial cada vez más potente, con recetas no-code y scripting multi-lenguaje. Las contribuciones de la comunidad —sobre todo nuevas recetas— son el corazón del proyecto.

Antes de escribir código, lee docs/INDICE.md (índice de toda la documentación) y el docs/CHANGELOG.md (estado actual).

1. Reglas de oro del repositorio

Estas reglas son obligatorias y mantienen la calidad del proyecto:

  1. Toda la documentación es total. Cada cambio de código se acompaña, en el mismo PR, de:
    • Nueva entrada en docs/CHANGELOG.md.
    • Subir AssemblyVersion en src/ClsMain.cs (SemVer).
    • Actualizar los .md afectados (API → SCRIPTING_CONTRATOS.md, etc.).
  2. Versionado atómico. Un PR = un cambio coherente. Mensaje de commit descriptivo (qué y por qué).
  3. Los tests viven en /.temp_tests (carpeta ignorada por git). Inclúyelos en la descripción del PR (qué probaste y el resultado).
  4. Nunca subas credenciales, cadenas de conexión reales, ni datos de empresas.

2. Flujo de trabajo

  1. Haz fork del repo y crea una rama descriptiva (feature/receta-cambiar-estatus).
  2. Compila y prueba (ver §3).
  3. Actualiza la documentación (regla #1).
  4. Abre un Pull Request contra main con la plantilla.

3. Compilar y probar

Requiere .NET SDK (8+). Desde la raíz:

# Compila el núcleo (DLL) y actualiza instalador\bin
.\build\generar_instalador.ps1

# (Opcional) empaqueta los .exe
.\build\generar_exes.ps1

Guía detallada: docs/DESARROLLO.md.

4. Estilo de código

  • Sigue el estilo del código existente: comentarios en español, nombres descriptivos, densidad de comentarios similar a la del archivo que tocas.
  • C# moderno (LangVersion=latest), target net48.
  • No introduzcas dependencias nuevas sin justificarlo en el PR.

5. Aportar una receta no-code

Las recetas son el contrato extensible (ver docs/RECETAS_NOCODE.md). Una receta nueva debe declarar su esquema de configuración (qué pregunta al crear el botón) y su implementación. Documenta el caso de uso y un ejemplo.

6. Reportar errores o pedir features

Usa las plantillas de Issues. Para vulnerabilidades de seguridad, NO abras un issue público: sigue SECURITY.md.

7. Licencia de tus contribuciones

Al contribuir, aceptas que tu aporte se publique bajo la GPL-3.0 del proyecto.