Contribute

We welcome contributions from developers, technical writers, and anyone interested in improving bank statement parsing for the finance community.

How to Contribute

Report Issues

Found a bug or have a feature request? Open an issue on GitHub. Please include:

• A clear description of the problem or suggestion.
• Steps to reproduce (for bugs).
• Your Python version and operating system.

Submit Code

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/your-feature).
3. Write tests for your changes (we require 100% branch coverage).
4. Run the test suite: pytest.
5. Submit a pull request with a clear description.

Improve Documentation

Documentation improvements are always welcome. You can:

• Fix typos or clarify existing content.
• Add new usage examples to the examples directory.
• Improve docstrings in the source code.

Development Setup

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

Code Standards

• All code must pass ruff linting and mypy type checking.
• All commits must be signed.
• All pull requests must maintain 100% branch coverage.
• Follow the existing code style and patterns.

Sponsor the Project

If Bank Statement Parser saves your team time, consider sponsoring the project on GitHub. Your support helps us maintain and improve the library.