Skip to content

Bijdragen aan het OTOBO Open-Source-project

OTOBO is open source onder de GitHub-organisatie RotherOSS (https://github.com/RotherOSS/otobo). Als je bugs wilt melden of je eigen code wilt bijdragen, volg dan deze workflow:


1. GitHub-workflow

1.1 Fork & Clone

  1. Maak een fork aan van https://github.com/RotherOSS/otobo.
  2. Kloon je fork lokaal:
    bash
    git clone https://github.com/<jouw-user>/otobo.git
    cd otobo

1.2 Branching

Maak voor elke wijziging een nieuwe branch aan:

bash
git checkout -b feature/<korte-beschrijving>

Voorbeeld:

bash
git checkout -b feature/add-hello-world-module

1.3 Commit & Push

  1. Implementeer je code.

  2. Voeg zinvolle commit-berichten toe:

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

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

1.4 Pull Request

  1. Open je fork op GitHub.
  2. Klik op Compare & pull request.
  3. Beschrijf in de PR-tekst kort wat je feature/bugfix doet en waarom het belangrijk is.
  4. Kies de juiste doel-branch (meestal master of development).

2. Code Style & Tests

2.1 CodePolicy

RotherOSS gebruikt het tool CodePolicy (https://github.com/RotherOSS/CodePolicy) om coding-standaarden te controleren.

  • Installatie:

    bash
    cpanm CodePolicy
  • Uitvoeren in de repo-root:

    bash
    CodePolicy --check .

2.2 Perl-modules & POD

  • Elke Kernel::System::* en Kernel::Modules::* module moet POD-documentatie bevatten.
  • Declareer afhankelijkheden in our @ObjectDependencies.
  • Let op use strict; use warnings;.

2.3 Unit-tests

OTOBO gebruikt Mojolicious-tests en [Test::More]. Plaats je tests in t/:

bash
prove -l t/MyModule.t

3. Issue-Management & Reviews

3.1 Issues openen

  • Zoek eerst naar bestaande issues.
  • Maak een issue aan met titel, reproductiestappen, logs en screenshots (indien nodig).

3.2 Labels & Templates

  • Gebruik de labels bug, enhancement, question.
  • Volg de issue- en PR-templates in de repo.

3.3 Code Reviews

  • Reageer tijdig op review-commentaren in de PR.
  • Voeg tests toe of wijzig de stijl als reviewers dit voorstellen.
  • Na goedkeuring wordt je PR gemerged.

4. Community & Support

Veel succes met het meewerken aan OTOBO!