Contribuer

Merci de l'intérêt porté à piighost. Cette page résume le workflow de contribution. Pour la version complète, voir CONTRIBUTING.md à la racine du dépôt.

Prérequis

Python 3.11+
uv comme gestionnaire de paquets
Un compte GitHub

Démarrer

Forker le dépôt sur GitHub.

Cloner votre fork localement :

git clone https://github.com/VOTRE-UTILISATEUR/piighost.git
cd piighost
git remote add upstream https://github.com/Athroniaeth/piighost.git

Installer les dépendances :
```
uv sync
```

Workflow

Créer une branche

Toujours depuis master :

git checkout -b feat/my-feature

Respecter les conventions

Protocoles à toutes les étapes du pipeline pour garder les composants interchangeables.
Dataclasses gelées pour les modèles (Entity, Detection, Span).
ExactMatchDetector dans les tests, jamais de vrai modèle NER en CI.
Commits conventionnels via Commitizen (feat:, fix:, refactor:, etc.).

Vérifications locales

Avant de soumettre une PR :

make format                          # corriger le format et le lint avec ruff
make lint                            # vérifier sans rien modifier
uv run pytest                        # lancer les tests
uv run pytest tests/ -k "test_name"  # lancer un test précis

make lint ne modifie aucun fichier et échoue au premier problème. Il vérifie le format avec ruff format --check, le lint avec ruff check, les types avec pyrefly, la sécurité avec bandit, puis la documentation avec le script d'audit des pages. make format corrige ce que ruff sait corriger.

Ouvrir la Pull Request

Titre clair suivant le format Commitizen.
Description qui explique le pourquoi plutôt que le quoi.
Lier l'issue correspondante (Fixes #42).
Screenshots ou exemples de sortie si pertinent.

Points d'extension

Les endroits les plus courants où contribuer sans toucher au cœur :

Nouveau détecteur : implémenter le protocole AnyDetector. Voir Étendre piighost.
Nouveau pack regex : publier un groupe de motifs sur le catalogue piighost, qu'une config tire ensuite par sa référence.
Nouvelle factory de placeholders : implémenter AnyPlaceholderFactory.