Comment contribuer ?¶
Contribuer au code¶
Merci de lire les lignes directives de la contribution.
Règles clés en bref¶
- Choisir d'abord un ticket (issue). Recherchez un ticket existant ou créez-en un, et commentez-le avant d'ouvrir une Pull Request. Attendez que le ticket vous soit assigné avant de commencer à travailler.
- Une Pull Request, un seul commit. Regroupez votre travail en un seul commit avec un message descriptif reflétant vos changements.
- Nommage. Créez une branche dédiée, nommée en fonction du ticket traité.
- Licence. En soumettant une Pull Request, vous placez votre contribution sous la licence LGPLv3 du projet (« Inbound = Outbound »).
Contributions assistées par l'IA¶
Il est possible d'utiliser des outils d'IA pour assister vos contributions, mais vous restez pleinement responsable de tout ce que vous soumettez.
- Comprendre : vous devez être en mesure d'expliquer chaque ligne de votre code.
- Tester : le code généré par l'IA doit passer tous les tests et vérifications de sécurité.
- Déclarer : indiquez un niveau d'assistance IA (0–5) dans le modèle de Pull Request.
- Assumer : vous êtes l'auteur. Si une personne relectrice demande « pourquoi ? », c'est vous qui répondez — pas l'IA.
Les outils d'IA ne doivent pas être utilisés pour corriger les tickets étiquetés good first issue. Ils existent pour l'apprentissage humain.
Contribuer à la traduction¶
Traduire la documentation¶
Il est possible de traduire la documentation, en créant / modifiant les fichiers markdown dans docs/doc dans le dépôt du site internet.
Traduire le logiciel¶
QualCoder gère la fonctionnalité multilingue grâce à deux types de fichiers de traduction :
- Les fichiers Gettext (.po ou . mo), qui contiennent la traduction du logiciel ;
- Les fichiers linguistiques QT (fichiers .ts ou .qm) correspondant à l’interface.
Pour traduire :
- Créer un fichier langue (lorsqu’il n’existe pas) avec cette commande :
python rebuild_lang.py --create --lang CODE_LANGUEIl est à noter que le nom de vos fichiers langues doit respecter le format ISO 639-1. - Si un fichier linguistique existe déjà, vous pouvez mettre à jour les traductions
python rebuild_lang.py --update --lang CODE_LANGUE. - Il est possible d’éditer les traductions des fichiers .po et .ts dans le dossier src/i18n à l’aide du logiciel Poedit.
- Une fois le travail terminé, compiler au format machine, à l’aide de cette commande :
python rebuild_lang.py --compile --lang CODE_LANGUE.
Glossaire concernant la traduction, afin d’avoir une cohérence dans la traduction :
- Speakers : Intervenant⋅es
- Coder : Codeur·euse
- Case : cas
- Transcript : Retranscription
- Counts : occurrences
- Automatic coding : autocodage
- Mark : Surligner
- Prompt AI : Instruction
- Stop words: mots vides
- Codebook : Grille de codage
- Red weak : Protanomalie
- Red blind : Protanopie
- Green weak : Deutéranomalie
- Green blind : Deutéranopie
- Pie charts : Diagrammes circulaires
- Bar charts : Graphique à barres