Contenu

À propos de cette section

Cette section contient la documentation pour les développeurs qui contribuent au projet PyFoundry.

Elle explique comment le code fonctionne et comment y contribuer efficacement.

Contenu suggéré

Voici les types de documentation que vous devriez ajouter dans cette section :

Architecture

• Vue d'ensemble de l'architecture du projet
• Diagrammes d'architecture (composants, flux de données)
• Choix de design et leurs justifications
• Structure des dossiers et organisation du code

Configuration de l'environnement

• Installation de l'environnement de développement
• Configuration VS Code / Dev Container
• Outils et extensions recommandés
• Configuration des secrets et variables d'environnement

Guide de contribution

• Processus de contribution (fork, branch, PR)
• Standards de code et conventions
• Comment écrire des tests
• Workflow TDD recommandé
• Comment utiliser les commandes Claude Code (/fix-issue, etc.)

Référence technique

• Description des modules principaux
• APIs internes et interfaces
• Gestion des dépendances
• Configuration des outils (ruff, mypy, pytest)

Processus de développement

• Cycle de développement (feature → tests → code → review)
• Stratégie de branches Git
• Processus de review de code
• Gestion des versions et releases

Recommandations pour une doc de qualité

Pour maintenir une documentation de qualité, voici les recommandations à suivre (par une IA ou pour un humain).

✅ Bonnes pratiques de rédaction

Décrire l'état actuel du système :

• Expliquer ce que le système fait maintenant

• Fournir des spécifications techniques et des exemples d'utilisation

• Documenter les fonctionnalités telles qu'elles existent

Éviter :

• ❌ Les références historiques ("L'issue #X a amélioré...")

• ❌ Les récits d'évolution ("Nous avons d'abord implémenté X, puis Y...")

• ❌ Les marqueurs temporels ("Nouvelle fonctionnalité", "Récemment ajouté")

• ❌ Les métriques de tests dans la documentation

Exemple

❌ Mauvais :

"Nouvelle dans l'issue #75 : La Phase 0 est maintenant bien meilleure grâce à la double confirmation... C'est une amélioration majeure par rapport à la version précédente."

✅ Bon :

"La Phase 0 utilise deux mécanismes d'enrichissement : la double confirmation quand Babelio retourne un score de confiance entre 0.85 et 0.99, et la correction d'auteur quand les livres ne sont pas trouvés."