Chúng tôi hoan nghênh sự đóng góp từ các nhà phát triển, người viết kỹ thuật và bất kỳ ai quan tâm đến việc cải thiện khả năng phân tích bảng sao kê ngân hàng cho cộng đồng tài chính.
Cách đóng góp
Báo cáo vấn đề
Tìm thấy một lỗi hoặc có một yêu cầu tính năng? Mở một vấn đề trên GitHub. Vui lòng bao gồm:
- Mô tả rõ ràng vấn đề hoặc đề xuất.
- Các bước tái tạo (đối với lỗi).
- Phiên bản Python và hệ điều hành của bạn.
Gửi mã
- Phân nhánh kho lưu trữ.
- Tạo một nhánh tính năng (
git checkout -b feature/your-feature). - Viết bài kiểm tra cho những thay đổi của bạn (chúng tôi yêu cầu phạm vi chi nhánh 100%).
- Chạy bộ thử nghiệm:
pytest. - Gửi yêu cầu kéo với mô tả rõ ràng.
Cải thiện tài liệu
Cải tiến tài liệu luôn được chào đón. Bạn có thể:
- Sửa lỗi chính tả hoặc làm rõ nội dung hiện có.
- Thêm các ví dụ sử dụng mới vào thư mục ví dụ.
- Cải thiện chuỗi tài liệu trong mã nguồn.
Thiết lập phát triển
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
Tiêu chuẩn mã
- Tất cả các mã phải vượt qua
ruffxơ vải vàmypykiểm tra kiểu. - Tất cả các cam kết phải được ký kết.
- Tất cả các yêu cầu kéo phải duy trì mức độ bao phủ 100% chi nhánh.
- Thực hiện theo kiểu và mẫu mã hiện có.
Tài trợ cho Dự án
Nếu Trình phân tích sao kê ngân hàng tiết kiệm thời gian cho nhóm của bạn, hãy xem xét tài trợ dự án trên GitHub. Sự hỗ trợ của bạn giúp chúng tôi duy trì và cải thiện thư viện.