Nous accueillons les contributions de développeurs, rédacteurs techniques et toute personne intéressée par l'amélioration de l'analyse des relevés bancaires pour la communauté financière.
Comment contribuer
Signaler des problèmes
Vous avez trouvé un bug ou souhaitez proposer une fonctionnalité ? Ouvrez une issue sur GitHub. Veuillez inclure :
- Une description claire du problème ou de la suggestion.
- Les étapes pour reproduire le problème (pour les bugs).
- Votre version de Python et votre système d'exploitation.
Soumettre du code
- Forkez le dépôt.
- Créez une branche de fonctionnalité (
git checkout -b feature/your-feature). - Écrivez des tests pour vos modifications (nous exigeons 100% de couverture de branches).
- Exécutez la suite de tests :
pytest. - Soumettez une pull request avec une description claire.
Améliorer la documentation
Les améliorations de la documentation sont toujours les bienvenues. Vous pouvez :
- Corriger les fautes de frappe ou clarifier le contenu existant.
- Ajouter de nouveaux exemples d'utilisation dans le répertoire examples.
- Améliorer les docstrings dans le code source.
Configuration de l'environnement de développement
git clone https://github.com/sebastienrousseau/bankstatementparser.git
cd bankstatementparser
python3 -m venv .venv && source .venv/bin/activate
pip install poetry && poetry install --with dev
pytest # Executer la suite de tests
Standards de code
- Tout le code doit passer le linting
ruffet la vérification de typesmypy. - Tous les commits doivent être signés.
- Toutes les pull requests doivent maintenir 100% de couverture de branches.
- Suivez le style de code et les patterns existants.
Sponsoriser le projet
Si Analyseur de relevés bancaires fait gagner du temps à votre équipe, envisagez de sponsoriser le projet sur GitHub. Votre soutien nous aide à maintenir et améliorer la bibliothèque.