Мы приветствуем вклад разработчиков, технических писателей и всех, кто заинтересован в улучшении анализа банковских выписок для финансового сообщества.
Как внести свой вклад
Сообщить о проблемах
Нашли ошибку или у вас есть запрос на добавление функции? Открыть вопрос на GitHub. Пожалуйста, включите:
- Четкое описание проблемы или предложения.
- Действия по воспроизведению (в случае ошибок).
- Ваша версия Python и операционная система.
Отправить код
- Форкните репозиторий.
- Создайте ветку функций (
git checkout -b feature/your-feature). - Напишите тесты своих изменений (требуем 100% покрытия ветки).
- Запустите набор тестов:
pytest. - Отправьте запрос на включение с четким описанием.
Улучшение документации
Улучшения документации всегда приветствуются. Ты можешь:
- Исправьте опечатки или уточните существующий контент.
- Добавьте новые примеры использования в каталог примеров. — Улучшение строк документации в исходном коде.
Настройка разработки
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 # Run the test suite
Стандарты кода
- Весь код должен пройти
ruffворс иmypyпроверка типа. - Все коммиты должны быть подписаны.
- Все запросы на включение должны обеспечивать 100% покрытие филиалов.
- Следуйте существующему стилю и шаблонам кода.
Спонсор проекта
Если анализатор банковских выписок экономит время вашей команды, рассмотрите возможность спонсорства проекта на GitHub. Ваша поддержка помогает нам поддерживать и улучшать библиотеку.