-
GitHub là nền tảng quản lý mã nguồn (phiên bản), hỗ trợ cộng tác, chia sẻ và lưu trữ dự án với các tính năng chính: Repo kho lưu trữ, Issues, Task, Projects, Milestone, label...
-
Cách đăng ký: Truy cập github.com rồi đăng ký bằng tài khoản của công ty, xác minh email và thiết lập bảo mật.
Tài liệu này được thiết kế dành cho nhân viên của FoxAI khi cần thực hiện các công việc như:
- Bộ phận lập trình viên (Devs) quản lý mã nguồn (source-code) một cách tập trung, thống nhất (đặc biệt là khi cả nhóm cùng code);
- Bộ phận tư vấn triển khai (Colsutant) cập nhật, sửa đổi và phát hành tài liệu đào tạo, hỗ trợ khách hàng một cách nhanh chóng (đặc biệt là khi cả nhóm cùng sửa từng phần trên cùng tài liệu);
- Bộ phận hành chính nhân sự cập nhật tài liệu, quy trình, quy định để truyền thông nội bộ một cách hiệu quả (có thể dùng Sharepoint với mục đích tương tự), tránh phân tán tài liệu ở nhiều nơi.
- Các thành viên trong dự án có thể dễ dàng theo dõi lại nội dung các biên bản cuộc họp (Issue), cùng nhau trao đổi tương tác qua Discussion, thành viên mới có thể xem lại dữ liệu History commit để nhanh chóng nắm bắt công việc.
- Leader dễ dàng giao việc (task) cho từng thành viên (assignee), quản lý tiến độ công việc, hỗ trợ nhân viên và báo cáo đánh giá chất lượng công việc.
Người dùng sau khi đọc tài liệu này có thể:
- Biết cách dùng công cụ Repository (Bản lưu trữ) để quản lý, chỉnh sửa, cập nhật tài liệu (Tab đầu tiên Code)
- Nắm được cách dùng công cụ Issue, Task để giao nhiệm vụ cho từng thành viên cụ thể.
- Thực hành được các công cụ Discussion để thảo luận, đưa ra ý tưởng, đề xuất giải pháp, tạo cuộc bình chọn, hỏi đáp Q&A với các thành viên khác.
- Ứng dụng được công cụ Project, Milestone để quản lý tiến độ các dự án đang triển khai.
- Hiểu được công cụ Insight (Hiểu biết sâu sắc dạng Dashboard) để có cái nhìn tổng quát theo từng contributors, Traffic (mức độ quan tâm) theo từng bài viết, Folk (quản lý phiên bản)...
1. Quản lý kho lưu trữ Repository
Tạo Repository
- Nhấn nút + (New) ở góc trên bên phải → New repository.
- Chọn Public/Private, đặt tên, mô tả.
- Chọn “Initialize this repository with a README” hoặc để trống nếu muốn tạo rỗng.
- Thiết lập branch chính (default branch) – thường là
main.
2. Quản lý dự án GitHub Projects
graph TD
A["Milestone - Giai đoạn"] --> B["Project - Dự án"]
B --> C["Issue - Công việc"]
C --> D["Task - Nhiệm vụ"]
2.1. Milestones
- Tạo milestone rồi gắn Issue vào milestone.
- GitHub hiển thị % công việc đã đóng (done) / tổng Issue.
2.2. Project
- Tại trang Projects (trong repository hoặc trong profile), nhấn New project.
- Đặt tên, chọn Template (nếu có).
2.3. Issue
- Tại tab Issues → New issue.
- Đặt tiêu đề, mô tả (có thể thêm checklist công việc con).
- Trong giao diện Issue, chọn Projects (phía bên phải), hoặc
- Vào giao diện Project → + Add item → Nhập
#+ số Issue. - Gắn nhãn (label), người xử lý (assignee), milestone.
- Thêm comment, checklist…
2.4. Task
- Là công việc con trong từng Issue, có thể chuyển thành Issue để quản lý tiến độ.
- Trong description, sử dụng mã Markdown -[] để tạo checklist box tương ứng với 1 Task.
- Ở Projects Beta, chọn Board view.
- Sử dụng các cột (chẳng hạn: To do, In progress, Done).
- Kéo – thả các card (Issue) giữa các cột để cập nhật tiến độ.
- Giúp xem các công việc theo timeline (thời gian).
- Gán start date, due date cho mỗi Issue.
- Thuận tiện cho việc sắp xếp thứ tự ưu tiên, theo dõi deadline.
- Nơi tập hợp những công việc chờ xử lý/ý tưởng.
- Chọn lọc các công việc cần làm trong giai đoạn sắp tới và chuyển chúng vào Board/Roadmap.
- Dạng bảng, hiển thị fields (các trường) như assignee, labels, due date…
- Tùy biến field (custom fields) để hiển thị chỉ số, % hoàn thành (nhập tay), v.v.
4.1. Discussions
- Tạo không gian chung để trao đổi, hỏi đáp, thảo luận.
- So sánh với Issue (phân biệt: Issue → công việc cần làm, Discussion → thảo luận chung).
- About Discussions
4.2. GitHub Actions
- Tự động hóa, CI/CD.
- Build/test code mỗi khi commit, deploy lên server…
- About GitHub Actions
4.3. ZenHub hoặc extension khác
- Nếu cần báo cáo chuyên sâu (velocity, burn-down chart…) có thể cài ZenHub extension.
- Tích hợp với GitHub Projects.
4.4. GitHub Pages
- Triển khai website tĩnh trực tiếp từ repo, dùng để xem trực tiếp các file dạng .html
- About GitHub Pages
5.1. Workflow cơ bản
- Tạo Issue → Thêm vào Project → Thảo luận → Pull Request → Merge → Đóng Issue.
5.2. Sử dụng nhãn (Label)
- Tạo nhãn
bug,enhancement,priority-high, v.v. để dễ lọc.
5.3. Regular review
- Thường xuyên rà soát Project (Board/Roadmap) theo tuần/sprint để cập nhật tiến độ, sắp xếp lại độ ưu tiên.
- Hướng dẫn bảo mật tài khoản GitHub