demo_docs/Guidlines/Quy trình cơ bản cho Dev.md

1. Đồng bộ Mã nguồn và Môi trường:

git checkout main
git pull origin main

=== Mục đích: Đảm bảo bạn có phiên bản code mới nhất từ nhánh chính trước khi bắt đầu công việc mới hoặc tiếp tục công việc cũ, tránh conflict.

git checkout feature/your-task-branch
git merge main // Xử lý Conflict nếu có

=== Cập nhật những thay đổi mới nhất từ `main` vào nhánh làm việc của bạn.

2. Tạo môi trường (lần đầu tiên)

Chạy các lệnh cần thiết để khởi động môi trường local (nếu chưa chạy):

• Tạo Các file cần thiết: .env
• Tạo các file mẫu: .gitignore , air.toml, Dockerfile, docker-compose.yml
• Cấu hình Global ban đầu

 git config --global commit.template ~/.gitmessage.txt : Gắn Template commit template
- git config --global user.name "Tên của bạn"
- git config --global user.email "email@example.com"

• Sử dụng Makefile (nếu có): make run-dev hoặc lệnh tương tự. Tham khảo:
• Sử dụng Docker Compose: docker-compose up -d. Tham khảo:
• Sử dụng Air cho Golang (nếu có): Air sẽ tự động theo dõi thay đổi. Tham khảo:

3. Viết Code và Unit Test

• Triển khai tính năng hoặc sửa lỗi theo yêu cầu.
• Viết Unit Test sau mỗi unit code. Tham khảo Unit Test Rules
• Thường xuyên chạy Unit Test
• Tuân thủ Coding Convention của dự án. Tham khảo Code Convention
• Chú ý đến phi chức năng & bảo mật cơ bản
• Commit code thường xuyên với các thay đổi nhỏ, có ý nghĩa
• Sử dụng commit message : Git Template#Git Message

git add .
git commit

4. Testing & Pull Request

• Chạy tất cả các Testing như trong quy trình CI trên Server(Lint, Unit Test, Integration Test, Securtiy Scan): Tham khảo Makefile
• Cập nhật lại nhánh với những thay đổi mới nhất từ main trước khi Pull Request

git fetch origin
git merge origin/main

• Push Code

git status // kiểm tra trước khi push code
git push origin feature/task

• Tạo PR trên Git Server & Viết mô tả PR rõ ràng
  • Link đến Task ID
  • Mô tả những gì đã làm
  • Hướng dẫn Test Manual cho người review (nếu có)
  • Gán người Review

6. Theo dõi Pipeline CI/CD

• Sau khi tạo PR, Pipeline tự động kích hoạt
• Theo dõi pipeline: Tham khảo Diagrams CICD - Pipeline Template(Dev) - Pipeline Template(Main)
• Kiểm tra pipeline khi lỗi, sửa lỗi, commit và push lại. Tham khảo Bộ Rule CICD

7. Sau khi Merge Code

• Merge Code sẽ do Lead Approve vào nhánh main/master
• Clean Nhánh

git checkout main
git pull origin main # Cập nhật local main
git branch -d feature/TASK-ID # Xóa nhánh local
git push origin --delete feature/TASK-ID # Xóa nhánh remote (nếu có quyền và team quy định)

8. Xử lý việc cuối ngày

• Cập nhật trạng thái task & Ghi chú tiến độ cho ngày hôm sau( nếu chưa hoàn tất)
• Commit cuối ngày và push lên nhánh của mình đang thực hiện (feature/task-id)

git add .
git commit
git push origin

Short CheatSheet (Go)

• go get --package_name-- : Cài đặt dependency
• go run /path/*.go : Chay Go
• go build /path/go : tạo thành file thực thi
• go mod tidy: Dọn dẹp dependencies
• go test -v ./... : Kiểm tra unit test
• golangci-lint run : Kiểm tra code style
• go test -cover ./... : Kiểm tra coverage của code
• go clean -cache|-testcache : Clean cache build / test
• go clean -i : xóa file biên dịch