Skip to content

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

  1. Crie um fork de https://github.com/RotherOSS/otobo.
  2. 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-module

1.3 Commit & Push

  1. Implemente seu código.

  2. Adicione mensagens de commit significativas:

    bash
    git add .
    git commit -m "Adds HelloWorld module with basic functionality"
  3. Envie seu branch:

    bash
    git push origin feature/add-hello-world-module

1.4 Pull Request

  1. Abra seu fork no GitHub.
  2. Clique em Compare & pull request.
  3. Descreva brevemente no texto do PR o que seu recurso/correção de bug faz e por que é importante.
  4. Selecione o branch de destino correto (geralmente master ou development).

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:

    bash
    cpanm CodePolicy
  • Execução na raiz do repositório:

    bash
    CodePolicy --check .

2.2 Módulos Perl & POD

  • Cada módulo Kernel::System::* e Kernel::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.t

3. 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

Boa sorte ao contribuir para o OTOBO!