Guide de Contribution

Nous vous remercions pour l’intérêt que vous portez à contribuer à ce projet open source, développé par le CNRS Sciences Informatiques. Ce guide a pour objectif de faciliter votre collaboration et d’assurer la qualité et la sécurité du code. En contribuant, vous acceptez que vos modifications soient diffusées sous la licence GPLv3.

Table des matières

Introduction
Comment contribuer
Fork et clonage du repository
Création d'une branche
Commits et messages de commit
Merge Request
Tests et validation
Documentation
Signalement de bugs et demandes de fonctionnalités
Communication et code de conduite
Licence
Remerciements

Introduction

Ce projet a été mis en place en transférant uniquement l’état actuel du code, sans copier l’historique, afin de protéger les informations sensibles. Votre contribution permettra d’améliorer le logiciel et de soutenir la recherche scientifique publique.

Comment contribuer

Fork et clonage du repository (dans le cadre d'une nouvelle instance de MyGDR)

Fork du projet :
Rendez-vous sur la page GitLab du projet et cliquez sur le bouton Fork pour créer votre propre copie.

Clonage en local :
Clonez votre fork sur votre machine. Par exemple :

git clone https://gitlab.example.com/votre-utilisateur/nom-du-projet.git
cd nom-du-projet

(Remplacez l'URL par celle de votre fork.)

Création d'une branche

Avant de commencer vos modifications, créez une branche dédiée afin de garder votre travail organisé :

    git checkout -b feature/description-de-votre-changement

Utilisez un nom de branche explicite, par exemple fix/bug-authentification ou feature/nouvelle-fonctionnalité.

Commits et messages de commit

Commits atomiques :
Veillez à ce que chaque commit représente une modification cohérente et isolée du code.
Messages de commit clairs :
Rédigez des messages concis et descriptifs. Par exemple :
```
git commit -m "Correction du bug d'authentification"
```

Merge Request

Poussez vos modifications :

git push origin feature/description-de-votre-changement

Créez une Merge Request (MR) :
Depuis l’interface GitLab, créez une MR en sélectionnant votre branche. Dans la description, merci d’indiquer :
Les modifications apportées.
Les issues résolues (exemple : "Fix bug d'authentification").
Les instructions pour tester vos changements, si nécessaire.

Tests et validation

Exécution des tests :
Avant de soumettre une MR, assurez-vous que l’ensemble des tests unitaires et d’intégration passe correctement en local. Les pipelines CI/CD se déclencheront automatiquement lors de la création de la MR.
Ajout de tests :
Si vous ajoutez de nouvelles fonctionnalités, merci d’ajouter des tests pour garantir leur bon fonctionnement et éviter toute régression.

Documentation

Mise à jour :
Si vos modifications affectent la documentation (README, Wiki, etc.), merci de la mettre à jour en conséquence.
Clarté :
Documentez précisément les changements apportés et, si nécessaire, fournissez des exemples d’utilisation.

Signalement de bugs et demandes de fonctionnalités

Création d’issues :
Pour signaler un bug ou proposer une amélioration, ouvrez une issue sur GitLab. Veuillez fournir des détails complets (étapes pour reproduire, environnement, etc.).
Suivi des issues :
Les issues seront traitées par les mainteneurs du projet en fonction de leur priorité et de leur impact.

Communication et code de conduite

Canaux de communication :
Possibilité d'échanges constructifs via les discussions sur GitLab et dans les issues.
Code de conduite :
Merci de consulter le fichier README.md et de respecter les règles de bonne conduite dans toutes vos interactions.

Licence

Ce projet est distribué sous la licence GPLv3 par le CNRS Sciences Informatiques. En contribuant, vous acceptez que vos modifications soient également couvertes par cette licence.

Remerciements

Nous vous remercions sincèrement pour votre contribution. Votre aide est essentielle pour faire évoluer ce projet et soutenir la recherche scientifique publique.

N’hésitez pas à contacter le mainteneur, Francis Hulin-Hubard, en cas de questions ou pour obtenir de l’aide. Bonne contribution !