Contribuir en el proyecto de código abierto OTOBO
OTOBO es de código abierto bajo la organización de GitHub RotherOSS (https://github.com/RotherOSS/otobo). Si deseas reportar errores o aportar tu propio código, sigue este flujo de trabajo:
1. Flujo de trabajo de GitHub
1.1 Fork & Clonar
- Crea un fork de
https://github.com/RotherOSS/otobo. - Clona tu fork localmente:bash
git clone https://github.com/<tu-usuario>/otobo.git cd otobo
1.2 Ramificación (Branching)
Crea una nueva rama para cada cambio:
bash
git checkout -b feature/<descripcion-corta>Ejemplo:
bash
git checkout -b feature/add-hello-world-module1.3 Commit & Push
Implementa tu código.
Añade mensajes de commit significativos:
bashgit add . git commit -m "Adds HelloWorld module with basic functionality"Haz push de tu rama:
bashgit push origin feature/add-hello-world-module
1.4 Pull Request
- Abre tu fork en GitHub.
- Haz clic en Compare & pull request.
- Describe brevemente en el texto del PR qué hace tu característica/corrección de errores y por qué es importante.
- Selecciona la rama de destino correcta (generalmente
masterodevelopment).
2. Estilo de código y Pruebas
2.1 CodePolicy
RotherOSS utiliza la herramienta CodePolicy (https://github.com/RotherOSS/CodePolicy) para verificar los estándares de codificación.
Instalación:
bashcpanm CodePolicyEjecutar en la raíz del repositorio:
bashCodePolicy --check .
2.2 Módulos Perl & POD
- Cada módulo
Kernel::System::*yKernel::Modules::*debe contener documentación POD. - Declara las dependencias en
our @ObjectDependencies. - Asegúrate de usar
use strict; use warnings;.
2.3 Pruebas Unitarias
OTOBO utiliza pruebas de Mojolicious y [Test::More]. Coloca tus pruebas en t/:
bash
prove -l t/MyModule.t3. Gestión de Issues y Revisiones
3.1 Abrir Issues
- Primero, busca issues existentes.
- Crea un issue con título, pasos de reproducción, logs y capturas de pantalla (si es necesario).
3.2 Etiquetas y Plantillas
- Utiliza las etiquetas bug, enhancement, question.
- Sigue las plantillas de issues y PR en el repositorio.
3.3 Revisiones de Código
- Responde puntualmente a los comentarios de revisión en el PR.
- Añade pruebas o modifica el estilo si los revisores lo sugieren.
- Después de la aprobación, tu PR será fusionado.
4. Comunidad y Soporte
- GitHub Discussions: https://github.com/RotherOSS/otobo/discussions
- Lista de correo y Chat: Los enlaces se encuentran en https://otobo.com/ en la sección "Comunidad".
- Documentación: Documentación para desarrolladores en https://doc.otobo.org/ ("How to Contribute").
¡Mucho éxito al contribuir a OTOBO!