Contribuir al proyecto de código abierto OTOBO
Contribuir al proyecto de código abierto OTOBO
Sección titulada «Contribuir al 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 contribuir con tu propio código, sigue este flujo de trabajo:
1. Flujo de trabajo de GitHub
Sección titulada «1. Flujo de trabajo de GitHub»1.1 Fork & Clone
Sección titulada «1.1 Fork & Clone»- Crea un fork de
https://github.com/RotherOSS/otobo. - Clona tu fork localmente:
Ventana de terminal git clone https://github.com/<tu-usuario>/otobo.gitcd otobo
1.2 Branching
Sección titulada «1.2 Branching»Crea una nueva rama para cada cambio:
git checkout -b feature/<breve-descripcion>Ejemplo:
git checkout -b feature/add-hello-world-module1.3 Commit & Push
Sección titulada «1.3 Commit & Push»-
Implementa tu código.
-
Añade mensajes de commit significativos:
Ventana de terminal git add .git commit -m "Adds HelloWorld module with basic functionality" -
Envía (push) tu rama:
Ventana de terminal git push origin feature/add-hello-world-module
1.4 Pull Request
Sección titulada «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 funcionalidad/corrección de errores y por qué es importante.
- Selecciona la rama de destino correcta (normalmente
masterodevelopment).
2. Estilo de código y pruebas
Sección titulada «2. Estilo de código y pruebas»2.1 CodePolicy
Sección titulada «2.1 CodePolicy»RotherOSS utiliza la herramienta CodePolicy (https://github.com/RotherOSS/CodePolicy) para verificar los estándares de codificación.
-
Instalación:
Ventana de terminal cpanm CodePolicy -
Ejecución en la raíz del repositorio:
Ventana de terminal CodePolicy --check .
2.2 Módulos Perl y POD
Sección titulada «2.2 Módulos Perl y 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
Sección titulada «2.3 Pruebas unitarias»OTOBO utiliza pruebas de Mojolicious y [Test::More]. Coloca tus pruebas en t/:
prove -l t/MyModule.t3. Gestión de Issues y revisiones
Sección titulada «3. Gestión de Issues y revisiones»3.1 Abrir Issues
Sección titulada «3.1 Abrir Issues»- Primero, busca si ya existen issues similares.
- Crea un issue con título, pasos de reproducción, logs y capturas de pantalla (si es necesario).
3.2 Etiquetas y plantillas
Sección titulada «3.2 Etiquetas y plantillas»- Utiliza las etiquetas bug, enhancement, question.
- Sigue las plantillas de issues y PR en el repositorio.
3.3 Code Reviews
Sección titulada «3.3 Code Reviews»- Responde puntualmente a los comentarios de revisión en el PR.
- Añade pruebas o cambia el estilo si los revisores lo sugieren.
- Tras la aprobación, tu PR será fusionado (merged).
4. Comunidad y soporte
Sección titulada «4. Comunidad y soporte»- GitHub Discussions: https://github.com/RotherOSS/otobo/discussions
- Lista de correo y chat: Encontrarás los enlaces en https://otobo.com/ en la sección “Community”.
- Documentación: Documentación para desarrolladores en https://doc.otobo.org/ (“How to Contribute”).
¡Mucho éxito contribuyendo a OTOBO!