Communauté et Contribution

L’excellence de cette Toolbox repose sur la collaboration. Vous trouverez ci-dessous les règles pour contribuer au projet et les standards de conduite attendus.

Guide de Contribution 🛠️

Merci de l’intérêt que vous portez à l’amélioration de la Toolbox IA ! L’excellence technique est notre priorité. Voici les règles à suivre pour que votre code soit accepté.

Processus de Développement

1. Ne jamais travailler sur main.

2. Créer une branche spécifique : Utilisez la nomenclature suivante : feat/nom-fonctionnalite pour une nouveauté, ou fix/nom-du-bug pour une correction.

   git checkout -b feat/ajout-division
   

3. Développement local : Assurez-vous d’avoir installé les dépendances de développement (uv sync).

4. Validation Qualité (Obligatoire) : Avant toute soumission, votre code doit passer nos deux juges de paix :

   Linting : uv run ruff check . (aucun avertissement toléré).

   Tests : uv run pytest (la couverture doit rester à 100%).

5. Soumettre une Pull Request (PR) : Ouvrez une PR sur GitHub vers la branche dev ou main. Notre robot de CI exécutera automatiquement les tests. Si la CI échoue, la fusion sera bloquée.

Philosophie du Code

Ajoutez des Docstrings au format Google pour toute nouvelle fonction.

Utilisez impérativement le Type Hinting (typage statique) de Python.

Écrivez des tests unitaires en utilisant les Fixtures et la Paramétrisation de Pytest si nécessaire.

---

Code de Conduite 🤝

En tant que contributeurs et mainteneurs de ce projet, nous nous engageons à faire de la participation à notre communauté une expérience exempte de harcèlement pour tout le monde, indépendamment de l’âge, de la taille, de l’apparence physique, du handicap, de l’origine ethnique, des caractéristiques sexuelles, de l’identité de genre et de son expression, du niveau d’expérience, de la nationalité, de l’apparence personnelle, de la race, de la religion, ou de l’identité et l’orientation sexuelle.

Nos Standards

Les comportements qui contribuent à créer un environnement positif incluent :

• L’utilisation d’un langage accueillant et inclusif.

• Le respect des points de vue et des expériences divergents.

• L’acceptation de la critique constructive (lors des Code Reviews).

• La concentration sur ce qui est le mieux pour la communauté et le projet.

Les comportements inacceptables incluent :

• L’utilisation d’un langage ou d’images sexualisés et les avances sexuelles non sollicitées.

• Le trolling, les commentaires insultants ou désobligeants, et les attaques personnelles.

• Le harcèlement public ou privé.

Application

Les mainteneurs du projet sont responsables de clarifier les normes de comportement acceptables et doivent prendre des mesures correctives justes et appropriées en réponse à tout cas de comportement inacceptable.