Contribuer au projet open source OTOBO
Contribuer au projet open source OTOBO
Section intitulée « Contribuer au projet open source OTOBO »OTOBO est open source sous l’organisation GitHub RotherOSS (https://github.com/RotherOSS/otobo). Si vous souhaitez signaler des bugs ou contribuer avec votre propre code, suivez ce workflow :
1. Workflow GitHub
Section intitulée « 1. Workflow GitHub »1.1 Fork & Clone
Section intitulée « 1.1 Fork & Clone »- Créez un fork de
https://github.com/RotherOSS/otobo. - Clonez votre fork localement :
Fenêtre de terminal git clone https://github.com/<votre-utilisateur>/otobo.gitcd otobo
1.2 Branching
Section intitulée « 1.2 Branching »Créez une nouvelle branche pour chaque modification :
git checkout -b feature/<courte-description>Exemple :
git checkout -b feature/add-hello-world-module1.3 Commit & Push
Section intitulée « 1.3 Commit & Push »-
Implémentez votre code.
-
Ajoutez des messages de commit explicites :
Fenêtre de terminal git add .git commit -m "Adds HelloWorld module with basic functionality" -
Poussez votre branche :
Fenêtre de terminal git push origin feature/add-hello-world-module
1.4 Pull Request
Section intitulée « 1.4 Pull Request »- Ouvrez votre fork sur GitHub.
- Cliquez sur Compare & pull request.
- Décrivez brièvement dans le texte de la PR ce que fait votre fonctionnalité/correction de bug et pourquoi elle est importante.
- Sélectionnez la branche cible appropriée (généralement
masteroudevelopment).
2. Code Style & Tests
Section intitulée « 2. Code Style & Tests »2.1 CodePolicy
Section intitulée « 2.1 CodePolicy »RotherOSS utilise l’outil CodePolicy (https://github.com/RotherOSS/CodePolicy) pour vérifier les standards de codage.
-
Installation :
Fenêtre de terminal cpanm CodePolicy -
Exécution à la racine du dépôt :
Fenêtre de terminal CodePolicy --check .
2.2 Modules Perl & POD
Section intitulée « 2.2 Modules Perl & POD »- Chaque module
Kernel::System::*etKernel::Modules::*doit contenir une documentation POD. - Déclarez les dépendances dans
our @ObjectDependencies. - Veillez à utiliser
use strict; use warnings;.
2.3 Tests unitaires
Section intitulée « 2.3 Tests unitaires »OTOBO utilise les tests Mojolicious et [Test::More]. Placez vos tests dans t/ :
prove -l t/MyModule.t3. Gestion des issues & Reviews
Section intitulée « 3. Gestion des issues & Reviews »3.1 Ouvrir des issues
Section intitulée « 3.1 Ouvrir des issues »- Recherchez d’abord les issues existantes.
- Créez une issue avec un titre, les étapes de reproduction, les logs et des captures d’écran (si nécessaire).
3.2 Labels & Templates
Section intitulée « 3.2 Labels & Templates »- Utilisez les labels bug, enhancement, question.
- Suivez les templates d’issue et de PR présents dans le dépôt.
3.3 Code Reviews
Section intitulée « 3.3 Code Reviews »- Réagissez rapidement aux commentaires de review dans la PR.
- Complétez les tests ou modifiez le style si les reviewers le suggèrent.
- Après approbation, votre PR sera mergée.
4. Communauté & Support
Section intitulée « 4. Communauté & Support »- GitHub Discussions : https://github.com/RotherOSS/otobo/discussions
- Liste de diffusion & Chat : Vous trouverez les liens sur https://otobo.com/ dans la section « Community ».
- Documentation : Documentation développeur sur https://doc.otobo.org/ (« How to Contribute »).
Bonne chance pour votre contribution à OTOBO !