Aller au contenu

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. Créez un fork de https://github.com/RotherOSS/otobo.
  2. Clonez votre fork localement :
    Fenêtre de terminal
    git clone https://github.com/<votre-utilisateur>/otobo.git
    cd otobo

Créez une nouvelle branche pour chaque modification :

Fenêtre de terminal
git checkout -b feature/<courte-description>

Exemple :

Fenêtre de terminal
git checkout -b feature/add-hello-world-module
  1. Implémentez votre code.

  2. Ajoutez des messages de commit explicites :

    Fenêtre de terminal
    git add .
    git commit -m "Adds HelloWorld module with basic functionality"
  3. Poussez votre branche :

    Fenêtre de terminal
    git push origin feature/add-hello-world-module
  1. Ouvrez votre fork sur GitHub.
  2. Cliquez sur Compare & pull request.
  3. Décrivez brièvement dans le texte de la PR ce que fait votre fonctionnalité/correction de bug et pourquoi elle est importante.
  4. Sélectionnez la branche cible appropriée (généralement master ou development).

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 .
  • Chaque module Kernel::System::* et Kernel::Modules::* doit contenir une documentation POD.
  • Déclarez les dépendances dans our @ObjectDependencies.
  • Veillez à utiliser use strict; use warnings;.

OTOBO utilise les tests Mojolicious et [Test::More]. Placez vos tests dans t/ :

Fenêtre de terminal
prove -l t/MyModule.t

  • 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).
  • Utilisez les labels bug, enhancement, question.
  • Suivez les templates d’issue et de PR présents dans le dépôt.
  • 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.

Bonne chance pour votre contribution à OTOBO !