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
- Maak een fork aan van
https://github.com/RotherOSS/otobo. - 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-module1.3 Commit & Push
Implementeer je code.
Voeg zinvolle commit-berichten toe:
bashgit add . git commit -m "Adds HelloWorld module with basic functionality"Push je branch:
bashgit push origin feature/add-hello-world-module
1.4 Pull Request
- Open je fork op GitHub.
- Klik op Compare & pull request.
- Beschrijf in de PR-tekst kort wat je feature/bugfix doet en waarom het belangrijk is.
- Kies de juiste doel-branch (meestal
masterofdevelopment).
2. Code Style & Tests
2.1 CodePolicy
RotherOSS gebruikt het tool CodePolicy (https://github.com/RotherOSS/CodePolicy) om coding-standaarden te controleren.
Installatie:
bashcpanm CodePolicyUitvoeren in de repo-root:
bashCodePolicy --check .
2.2 Perl-modules & POD
- Elke
Kernel::System::*enKernel::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.t3. 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
- GitHub Discussions: https://github.com/RotherOSS/otobo/discussions
- Mailinglijst & Chat: Links vind je op https://otobo.com/ onder het kopje „Community“.
- Documentatie: Developer-docs op https://doc.otobo.org/ („How to Contribute“).
Veel succes met het meewerken aan OTOBO!