Contributing
Hướng dẫn đóng góp cho Islam.io.vn
Chào mừng contributor!
Islam.io.vn là dự án cộng đồng. Mọi đóng góp đều có giá trị — từ sửa typo trong docs đến thêm dữ liệu thánh đường hay cải thiện API.
Cách đóng góp
1. Báo cáo lỗi
Nếu bạn tìm thấy lỗi trong API, dữ liệu sai, hoặc docs không rõ:
- Kiểm tra Issues xem đã có ai báo chưa
- Mở issue mới với template phù hợp
- Mô tả rõ: lỗi gì, reproduce như thế nào, expected behavior
2. Đóng góp dữ liệu thánh đường
Đây là đóng góp quan trọng nhất hiện tại:
- Fork repo islamiovn/islamiovn
- Chỉnh sửa file
data/mosques.json - Thêm thông tin thánh đường theo schema
- Tạo Pull Request với mô tả rõ ràng
Lưu ý khi thêm dữ liệu:
- Kiểm tra tọa độ GPS chính xác (dùng Google Maps)
- Xác minh địa chỉ thực tế
- Không thêm thông tin chưa được xác minh
3. Cải thiện documentation
Docs luôn có thể tốt hơn:
- Fork repo
- Chỉnh sửa file
.mdxtrongcontent/docs/ - Tạo Pull Request
4. Đóng góp code
Trước khi code:
- Đọc Architecture Overview
- Mở issue để thảo luận approach trước
- Assign issue cho bản thân
Setup môi trường:
git clone https://github.com/islamiovn/islamiovn.git
cd islamiovn
npm install
npm run devCode Standards
- TypeScript cho tất cả code mới
- Biome cho linting và formatting (
npm run lint,npm run format) - Commit message theo Conventional Commits
feat: add prayer times for Hanoi
fix: correct mosque coordinates in An Giang
docs: update API overview
data: add 5 mosques in Ho Chi Minh CityPull Request Process
- Fork → Branch → Commit → Push → PR
- PR title rõ ràng, mô tả đầy đủ
- Đợi review từ maintainer (thường trong 48h)
- Address feedback nếu có
- Merge sau khi approved
Code of Conduct
- Tôn trọng mọi contributor
- Không phân biệt đối xử
- Thảo luận dựa trên kỹ thuật, không cá nhân
- Giữ môi trường thân thiện và chuyên nghiệp
Liên hệ
- GitHub Issues: github.com/islamiovn/islamiovn/issues
- Email: contribute@islam.io.vn (sắp ra)
Jazakallahu Khayran cho mọi đóng góp! 🤲