Hướng Dẫn Đóng Góp¶

Cảm ơn bạn quan tâm đến việc đóng góp cho GreenMap! Dưới đây là hướng dẫn để bắt đầu.

Quy Trình Đóng Góp¶

graph LR
    A[Fork Repo] --> B[Clone Local]
    B --> C[Create Branch]
    C --> D[Make Changes]
    D --> E[Commit]
    E --> F[Push]
    F --> G[Create PR]
    G --> H[Code Review]
    H --> I[Merge]

Bước Chi Tiết¶

1. Fork Repository¶

Click nút Fork trên GitHub để tạo bản sao về tài khoản của bạn.

2. Clone về máy¶

git clone https://github.com/YOUR_USERNAME/GreenMap-Backend.git
cd GreenMap-Backend

3. Tạo Branch mới¶

git checkout -b feature/ten-tinh-nang

Quy ước đặt tên branch:

feature/ - Tính năng mới
fix/ - Sửa lỗi
docs/ - Cập nhật tài liệu
refactor/ - Refactor code

4. Thực hiện thay đổi¶

Viết code, test và commit.

5. Commit¶

git add .
git commit -m "feat(map): add new traffic layer"

Quy ước Commit Message:

<type>(<scope>): <description>

[optional body]

Types:

Type	Mô tả
`feat`	Tính năng mới
`fix`	Sửa lỗi
`docs`	Cập nhật tài liệu
`style`	Format code
`refactor`	Refactor
`test`	Thêm test
`chore`	Công việc bảo trì

6. Push và tạo Pull Request¶

git push origin feature/ten-tinh-nang

Sau đó vào GitHub và tạo Pull Request.

Code Style¶

Python (Backend)¶

Tuân thủ PEP 8
Sử dụng black để format
Type hints cho tất cả functions

# Format code
black app/

# Check linting
flake8 app/

JavaScript/React (Frontend)¶

Tuân thủ Airbnb Style Guide
Sử dụng ESLint và Prettier

# Lint
npm run lint

# Format
npm run format

Kotlin (Mobile)¶

Tuân thủ Kotlin Coding Conventions
Sử dụng ktlint

Code Review Checklist¶

Khi review PR, chúng tôi kiểm tra:

Code tuân thủ style guide
Có test cho tính năng mới
Không có lỗi lint/compile
Tài liệu được cập nhật
Commit message đúng format
Không có hardcoded secrets

Code of Conduct¶

Chúng tôi tuân thủ Contributor Covenant Code of Conduct.

Tóm tắt:

🤝 Tôn trọng lẫn nhau
💬 Giao tiếp xây dựng
🚫 Không quấy rối
🌈 Chào đón mọi đóng góp

Cần Hỗ Trợ?¶

💬 Mở Discussion trên GitHub
📧 Email: contributors@greenmap.hanoi
📖 Đọc tài liệu Developer Guide