Contribuindo no Projeto Open Source OTOBO
OTOBO é Open Source sob a organização GitHub RotherOSS (https://github.com/RotherOSS/otobo). Se você deseja relatar bugs ou contribuir com seu próprio código, siga este fluxo de trabalho:
1. Fluxo de Trabalho do GitHub
1.1 Fork & Clone
- Crie um fork de
https://github.com/RotherOSS/otobo. - Clone seu fork localmente:bash
git clone https://github.com/<seu-user>/otobo.git cd otobo
1.2 Branching
Crie um novo branch para cada alteração:
bash
git checkout -b feature/<curta-descrição>Exemplo:
bash
git checkout -b feature/add-hello-world-module1.3 Commit & Push
Implemente seu código.
Adicione mensagens de commit significativas:
bashgit add . git commit -m "Adds HelloWorld module with basic functionality"Envie seu branch:
bashgit push origin feature/add-hello-world-module
1.4 Pull Request
- Abra seu fork no GitHub.
- Clique em Compare & pull request.
- Descreva brevemente no texto do PR o que seu recurso/correção de bug faz e por que é importante.
- Selecione o branch de destino correto (geralmente
masteroudevelopment).
2. Estilo de Código & Testes
2.1 CodePolicy
RotherOSS utiliza a ferramenta CodePolicy (https://github.com/RotherOSS/CodePolicy) para verificar os padrões de codificação.
Instalação:
bashcpanm CodePolicyExecução na raiz do repositório:
bashCodePolicy --check .
2.2 Módulos Perl & POD
- Cada módulo
Kernel::System::*eKernel::Modules::*deve conter documentação POD. - Declare dependências em
our @ObjectDependencies. - Certifique-se de usar
use strict; use warnings;.
2.3 Testes Unitários
OTOBO usa testes Mojolicious e [Test::More]. Coloque seus testes em t/:
bash
prove -l t/MyModule.t3. Gerenciamento de Issues & Revisões
3.1 Abrindo Issues
- Primeiro, procure por issues existentes.
- Crie uma issue com título, passos para reprodução, logs e screenshots (se necessário).
3.2 Labels & Templates
- Use os labels bug, enhancement, question.
- Siga os templates de issue e PR no repositório.
3.3 Revisões de Código
- Responda prontamente aos comentários de revisão no PR.
- Adicione testes ou altere o estilo conforme sugerido pelos revisores.
- Após a aprovação, seu PR será mesclado.
4. Comunidade & Suporte
- GitHub Discussions: https://github.com/RotherOSS/otobo/discussions
- Lista de E-mails & Chat: Links podem ser encontrados em https://otobo.com/ na seção "Community".
- Documentação: Documentação para desenvolvedores em https://doc.otobo.org/ ("How to Contribute").
Boa sorte ao contribuir para o OTOBO!