我们欢迎开发人员、技术作家以及任何有兴趣改进金融界银行对账单解析的人做出贡献。
如何贡献
报告问题
发现错误或有功能请求? [在 GitHub 上打开问题](https://github.com/sebastienrousseau/bankstatementparser/issues)。请包括:
- 问题或建议的清晰描述。
- 重现步骤(针对错误)。
- 您的 Python 版本和操作系统。
提交代码
- 分叉[存储库](https://github.com/sebastienrousseau/bankstatementparser)。
- 创建功能分支(
git checkout -b feature/your-feature)。 - 为您的更改编写测试(我们要求 100% 分支覆盖率)。
- 运行测试套件:
pytest。 - 提交带有清晰描述的拉取请求。
改进文档
文档改进总是受欢迎的。你可以:
- 修复拼写错误或澄清现有内容。
- 将新的使用示例添加到[示例目录](https://github.com/sebastienrousseau/bankstatementparser/tree/main/examples)。
- 改进源代码中的文档字符串。
开发设置
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 上的项目](https://github.com/sponsors/sebastienrousseau)。您的支持有助于我们维护和改进图书馆。