From 682e196cd7e012fb52c61c210679e0cec9770446 Mon Sep 17 00:00:00 2001 From: Bastien Le Querrec <blq@laquadrature.net> Date: Sun, 9 Jun 2024 14:10:46 +0200 Subject: [PATCH] README: ajout des instructions de contribution --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5627db0..5ccc910 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,15 @@ Les options suivantes peuvent être précisées, par un paramètre si l'utilitai Les contributions à ce projet sont les bienvenues ! -Vous pouvez rejoindre le salon de discussion à ce sujet sur Matrix : `#Attrap:laquadrature.net` +Chaque administration est gérée par un fichier dont le nom correspond à son identifiant (`Attrap_XXX.py`). Commencez par copier un de ces fichiers puis adaptez son code à l'administration que vous voulez ajouter. Il est impératif de lancer le moins de requêtes possibles vers le site de l'administration : lorsqu'une administration a une page par année ou par mois, ne lancez une requête que vers les pages qui correspondent à la plage temporelle demandée dans la valeur de configuration `NOT_BEFORE`. + +Avant d'ouvrir une merge request, assurez-vous que : +- l'administration est activée dans `cli.py` et dans `Makefile` ; +- il existe un job dans la CI (`.gitlab-ci.yml`) pour l'administration ; +- le fichier de README indique que la nouvelle administration est supportée ; +- vous n'avez qu'un seul commit par nouvelle préfecture (sinon, il faut faire un squash), de la forme `identifiant_de_l'administration: ajout de nom_complet_de_l'administration`. + +Vous pouvez rejoindre le salon de discussion Matrix du projet : `#Attrap:laquadrature.net`. ## Licence -- GitLab