Ми вітаємо внески розробників, технічних авторів і всіх, хто зацікавлений у покращенні аналізу банківських виписок для фінансової спільноти.
Як зробити внесок
Повідомити про проблеми
Знайшли помилку або маєте запит на доповнення? Відкрити випуск на 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. Ваша підтримка допомагає нам підтримувати та вдосконалювати бібліотеку.