22 KiB

Raw Permalink Blame History

Giới thiệu về GitHub

Bài học này sẽ giới thiệu những kiến thức cơ bản về GitHub, một nền tảng để lưu trữ và quản lý các thay đổi trong mã nguồn của bạn.

Sketchnote bởi Tomomi Imura

Câu hỏi trước bài giảng

Giới thiệu

Trong bài học này, chúng ta sẽ tìm hiểu:

cách theo dõi công việc bạn thực hiện trên máy tính của mình
cách làm việc trên các dự án cùng với người khác
cách đóng góp vào phần mềm mã nguồn mở

Yêu cầu trước khi bắt đầu

Trước khi bắt đầu, bạn cần kiểm tra xem Git đã được cài đặt chưa. Trong terminal, gõ: git --version

Nếu Git chưa được cài đặt, tải Git. Sau đó, thiết lập hồ sơ Git cục bộ của bạn trong terminal:

git config --global user.name "your-name"
git config --global user.email "your-email"

Để kiểm tra xem Git đã được cấu hình chưa, bạn có thể gõ: git config --list

Bạn cũng sẽ cần một tài khoản GitHub, một trình soạn thảo mã (như Visual Studio Code), và mở terminal (hoặc: command prompt).

Truy cập github.com và tạo tài khoản nếu bạn chưa có, hoặc đăng nhập và điền thông tin hồ sơ của bạn.

✅ GitHub không phải là kho mã duy nhất trên thế giới; còn có những nền tảng khác, nhưng GitHub là nền tảng được biết đến nhiều nhất.

Chuẩn bị

Bạn sẽ cần một thư mục chứa dự án mã nguồn trên máy tính cục bộ của mình (laptop hoặc PC), và một kho lưu trữ công khai trên GitHub, nơi sẽ đóng vai trò làm ví dụ để bạn học cách đóng góp vào các dự án của người khác.

Quản lý mã nguồn

Giả sử bạn có một thư mục cục bộ chứa một dự án mã nguồn và bạn muốn bắt đầu theo dõi tiến trình của mình bằng git - hệ thống kiểm soát phiên bản. Một số người so sánh việc sử dụng git giống như viết một lá thư tình gửi đến bản thân trong tương lai. Khi đọc lại các thông điệp commit sau vài ngày, vài tuần hoặc vài tháng, bạn sẽ nhớ lại lý do tại sao bạn đã đưa ra quyết định đó, hoặc "quay lại" một thay đổi - điều này xảy ra khi bạn viết các thông điệp commit tốt.

Nhiệm vụ: Tạo kho lưu trữ và commit mã nguồn

Xem video

Tạo kho lưu trữ trên GitHub. Trên GitHub.com, trong tab kho lưu trữ, hoặc từ thanh điều hướng ở góc trên bên phải, tìm nút new repo.
1. Đặt tên cho kho lưu trữ (thư mục) của bạn.
2. Chọn create repository.
Điều hướng đến thư mục làm việc của bạn. Trong terminal, chuyển đến thư mục (còn gọi là thư mục làm việc) mà bạn muốn bắt đầu theo dõi. Gõ:
```
cd [name of your folder]
```
Khởi tạo một kho lưu trữ git. Trong dự án của bạn, gõ:
```
git init
```
Kiểm tra trạng thái. Để kiểm tra trạng thái của kho lưu trữ, gõ:
```
git status
```
Kết quả có thể trông giống như sau:
```
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)

     modified:   file.txt
     modified:   file2.txt
```
Thông thường, lệnh git status sẽ cho bạn biết những tệp nào đã sẵn sàng để lưu vào kho lưu trữ hoặc có thay đổi mà bạn có thể muốn lưu lại.
Thêm tất cả các tệp để theo dõi Điều này còn được gọi là đưa tệp vào khu vực staging.
```
git add .
```
Lệnh git add cùng với đối số . chỉ định rằng tất cả các tệp và thay đổi của bạn sẽ được theo dõi.
Thêm các tệp được chọn để theo dõi
```
git add [file or folder name]
```
Điều này giúp chúng ta chỉ thêm các tệp được chọn vào khu vực staging khi không muốn commit tất cả các tệp cùng một lúc.
Hủy bỏ staging tất cả các tệp
```
git reset
```
Lệnh này giúp chúng ta hủy bỏ staging tất cả các tệp cùng một lúc.
Hủy bỏ staging một tệp cụ thể
```
git reset [file or folder name]
```
Lệnh này giúp chúng ta hủy bỏ staging chỉ một tệp cụ thể mà chúng ta không muốn đưa vào commit tiếp theo.
Lưu công việc của bạn. Tại thời điểm này, bạn đã thêm các tệp vào cái gọi là khu vực staging. Đây là nơi Git đang theo dõi các tệp của bạn. Để làm cho thay đổi trở nên vĩnh viễn, bạn cần commit các tệp. Để làm điều này, bạn tạo một commit bằng lệnh git commit. Một commit đại diện cho một điểm lưu trong lịch sử của kho lưu trữ của bạn. Gõ lệnh sau để tạo một commit:
```
git commit -m "first commit"
```
Lệnh này commit tất cả các tệp của bạn, thêm thông điệp "first commit". Đối với các thông điệp commit trong tương lai, bạn sẽ muốn mô tả chi tiết hơn để truyền đạt loại thay đổi bạn đã thực hiện.
Kết nối kho lưu trữ Git cục bộ của bạn với GitHub. Một kho lưu trữ Git trên máy của bạn là tốt, nhưng đến một lúc nào đó, bạn sẽ muốn sao lưu các tệp của mình ở đâu đó và cũng mời người khác làm việc cùng bạn trên kho lưu trữ của mình. Một nơi tuyệt vời để làm điều đó là GitHub. Nhớ rằng chúng ta đã tạo một kho lưu trữ trên GitHub, vì vậy điều duy nhất cần làm là kết nối kho lưu trữ Git cục bộ của bạn với GitHub. Lệnh git remote add sẽ làm điều đó. Gõ lệnh sau:

Lưu ý, trước khi gõ lệnh, hãy truy cập trang kho lưu trữ GitHub của bạn để tìm URL kho lưu trữ. Bạn sẽ sử dụng nó trong lệnh dưới đây. Thay thế https://github.com/username/repository_name.git bằng URL GitHub của bạn.
```
git remote add origin https://github.com/username/repository_name.git
```
Lệnh này tạo một remote, hoặc kết nối, có tên là "origin" trỏ đến kho lưu trữ GitHub mà bạn đã tạo trước đó.
Gửi các tệp cục bộ lên GitHub. Cho đến nay, bạn đã tạo một kết nối giữa kho lưu trữ cục bộ và kho lưu trữ GitHub. Hãy gửi các tệp này lên GitHub bằng lệnh git push, như sau:

Lưu ý, tên nhánh của bạn có thể khác mặc định so với main.
```
git push -u origin main
```
Lệnh này gửi các commit của bạn trong nhánh "main" lên GitHub.
Thêm các thay đổi mới. Nếu bạn muốn tiếp tục thực hiện các thay đổi và đẩy chúng lên GitHub, bạn chỉ cần sử dụng ba lệnh sau:
```
git add .
git commit -m "type your commit message here"
git push
```
Mẹo, bạn cũng có thể muốn sử dụng tệp .gitignore để ngăn các tệp bạn không muốn theo dõi xuất hiện trên GitHub - như tệp ghi chú mà bạn lưu trữ trong cùng thư mục nhưng không có chỗ trong kho lưu trữ công khai. Bạn có thể tìm các mẫu tệp .gitignore tại .gitignore templates.

Thông điệp commit

Một dòng tiêu đề commit Git tuyệt vời hoàn thành câu sau: Nếu được áp dụng, commit này sẽ <dòng tiêu đề của bạn ở đây>

Đối với tiêu đề, sử dụng thì hiện tại, dạng mệnh lệnh: "thay đổi" thay vì "đã thay đổi" hoặc "đang thay đổi". Cũng như trong tiêu đề, trong phần thân (tùy chọn), cũng sử dụng thì hiện tại, dạng mệnh lệnh. Phần thân nên bao gồm lý do cho thay đổi và so sánh điều này với hành vi trước đó. Bạn đang giải thích tại sao, không phải như thế nào.

✅ Dành vài phút để lướt qua GitHub. Bạn có thể tìm thấy một thông điệp commit thực sự tuyệt vời không? Bạn có thể tìm thấy một thông điệp rất tối giản không? Theo bạn, thông tin nào là quan trọng và hữu ích nhất để truyền đạt trong một thông điệp commit?

Nhiệm vụ: Cộng tác

Lý do chính để đưa mọi thứ lên GitHub là để làm cho việc cộng tác với các nhà phát triển khác trở nên khả thi.

Làm việc trên các dự án cùng người khác

Xem video

Trong kho lưu trữ của bạn, điều hướng đến Insights > Community để xem dự án của bạn so sánh như thế nào với các tiêu chuẩn cộng đồng được khuyến nghị.

Đây là một số điều có thể cải thiện kho lưu trữ GitHub của bạn:

Mô tả. Bạn đã thêm mô tả cho dự án của mình chưa?
README. Bạn đã thêm README chưa? GitHub cung cấp hướng dẫn để viết một README.
Hướng dẫn đóng góp. Dự án của bạn có hướng dẫn đóng góp không?
Quy tắc ứng xử. Một Quy tắc ứng xử,
Giấy phép. Có lẽ quan trọng nhất, một giấy phép?

Tất cả các tài nguyên này sẽ có lợi cho việc giới thiệu các thành viên mới vào nhóm. Và đây thường là những điều mà các nhà đóng góp mới xem xét trước khi thậm chí nhìn vào mã nguồn của bạn, để tìm hiểu xem dự án của bạn có phải là nơi phù hợp để họ dành thời gian hay không.

✅ Các tệp README, mặc dù mất thời gian để chuẩn bị, thường bị bỏ qua bởi các nhà bảo trì bận rộn. Bạn có thể tìm thấy một ví dụ về một README đặc biệt mô tả không? Lưu ý: có một số công cụ để giúp tạo README tốt mà bạn có thể muốn thử.

Nhiệm vụ: Gộp mã nguồn

Tài liệu đóng góp giúp mọi người đóng góp vào dự án. Nó giải thích các loại đóng góp mà bạn đang tìm kiếm và cách quy trình hoạt động. Các nhà đóng góp sẽ cần thực hiện một loạt các bước để có thể đóng góp vào kho lưu trữ của bạn trên GitHub:

Fork kho lưu trữ của bạn. Bạn có thể muốn mọi người fork dự án của mình. Fork có nghĩa là tạo một bản sao của kho lưu trữ trên hồ sơ GitHub của họ.
Clone. Từ đó, họ sẽ clone dự án về máy cục bộ của họ.
Tạo một nhánh. Bạn sẽ muốn yêu cầu họ tạo một nhánh cho công việc của họ.
Tập trung thay đổi vào một khu vực. Yêu cầu các nhà đóng góp tập trung các đóng góp của họ vào một điều tại một thời điểm - theo cách đó, khả năng bạn có thể gộp công việc của họ sẽ cao hơn. Hãy tưởng tượng họ viết một bản sửa lỗi, thêm một tính năng mới và cập nhật một số bài kiểm tra - điều gì sẽ xảy ra nếu bạn muốn, hoặc chỉ có thể triển khai 2 trong số 3, hoặc 1 trong số 3 thay đổi?

✅ Hãy tưởng tượng một tình huống mà các nhánh đặc biệt quan trọng đối với việc viết và triển khai mã nguồn tốt. Bạn có thể nghĩ ra những trường hợp sử dụng nào?

Lưu ý, hãy là sự thay đổi mà bạn muốn thấy trên thế giới, và tạo các nhánh cho công việc của chính bạn. Bất kỳ commit nào bạn thực hiện sẽ được thực hiện trên nhánh mà bạn hiện đang "checkout". Sử dụng git status để xem bạn đang ở nhánh nào.

Hãy cùng đi qua quy trình làm việc của một nhà đóng góp. Giả sử nhà đóng góp đã fork và clone kho lưu trữ, vì vậy họ đã có một kho lưu trữ Git sẵn sàng để làm việc trên máy cục bộ của họ:

Tạo một nhánh. Sử dụng lệnh git branch để tạo một nhánh sẽ chứa các thay đổi mà họ dự định đóng góp:
```
git branch [branch-name]
```
Chuyển sang nhánh làm việc. Chuyển sang nhánh được chỉ định và cập nhật thư mục làm việc bằng git switch:
```
git switch [branch-name]
```
Thực hiện công việc. Tại thời điểm này, bạn muốn thêm các thay đổi của mình. Đừng quên thông báo cho Git về điều đó bằng các lệnh sau:
```
git add .
git commit -m "my changes"
```
Đảm bảo bạn đặt tên commit tốt, vì lợi ích của bạn cũng như của người bảo trì kho lưu trữ mà bạn đang giúp đỡ.
Kết hợp công việc của bạn với nhánh main. Đến một lúc nào đó, bạn đã hoàn thành công việc và muốn kết hợp công việc của mình với nhánh main. Nhánh main có thể đã thay đổi trong khi đó, vì vậy hãy đảm bảo bạn cập nhật nó lên phiên bản mới nhất bằng các lệnh sau:
```
git switch main
git pull
```
Tại thời điểm này, bạn muốn đảm bảo rằng bất kỳ xung đột nào, những tình huống mà Git không thể dễ dàng kết hợp các thay đổi, xảy ra trong nhánh làm việc của bạn. Do đó, chạy các lệnh sau:
```
git switch [branch_name]
git merge main
```
Lệnh này sẽ mang tất cả các thay đổi từ main vào nhánh của bạn và hy vọng bạn có thể tiếp tục. Nếu không, VS Code sẽ cho bạn biết nơi Git bị nhầm lẫn và bạn chỉ cần chỉnh sửa các tệp bị ảnh hưởng để xác định nội dung nào là chính xác nhất.
Gửi công việc của bạn lên GitHub. Gửi công việc của bạn lên GitHub có nghĩa là hai điều. Đẩy nhánh của bạn lên kho lưu trữ của bạn và sau đó mở một PR, Pull Request.
```
git push --set-upstream origin [branch-name]
```
Lệnh trên tạo nhánh trên kho lưu trữ đã fork.
Mở một PR. Tiếp theo, bạn muốn mở một PR. Bạn làm điều đó bằng cách điều hướng đến kho lưu trữ đã fork trên GitHub. Bạn sẽ thấy một chỉ báo trên GitHub hỏi liệu bạn có muốn tạo một PR mới không, bạn nhấp vào đó và được đưa đến giao diện nơi bạn có thể thay đổi tiêu đề thông điệp commit, đưa ra mô tả phù hợp hơn. Bây giờ người bảo trì kho lưu trữ mà bạn đã fork sẽ thấy PR này và hy vọng họ sẽ đánh giá cao và gộp PR của bạn. Bạn bây giờ là một nhà đóng góp, tuyệt vời :)
Dọn dẹp. Việc dọn dẹp sau khi bạn thành công gộp một PR được coi là một thực hành tốt. Bạn muốn dọn dẹp cả nhánh cục bộ của mình và nhánh bạn đã đẩy lên GitHub. Đầu tiên, hãy xóa nó cục bộ bằng lệnh sau:
```
git branch -d [branch-name]
```
Đảm bảo bạn truy cập trang GitHub của kho lưu trữ đã fork và xóa nhánh từ xa mà bạn vừa đẩy lên. Pull request có vẻ là một thuật ngữ kỳ lạ vì thực tế bạn muốn "đẩy" các thay đổi của mình vào dự án. Nhưng người duy trì (chủ dự án) hoặc nhóm cốt lõi cần xem xét các thay đổi của bạn trước khi hợp nhất chúng vào nhánh "main" của dự án, vì vậy thực chất bạn đang yêu cầu một quyết định thay đổi từ người duy trì.

Pull request là nơi để so sánh và thảo luận về các khác biệt được giới thiệu trên một nhánh với các đánh giá, bình luận, kiểm tra tích hợp, và nhiều hơn nữa. Một pull request tốt tuân theo các quy tắc tương tự như một thông điệp commit. Bạn có thể thêm tham chiếu đến một vấn đề trong trình theo dõi vấn đề, ví dụ khi công việc của bạn sửa một vấn đề. Điều này được thực hiện bằng cách sử dụng # theo sau bởi số của vấn đề. Ví dụ: #97.

🤞Hy vọng rằng tất cả các kiểm tra đều vượt qua và chủ dự án hợp nhất các thay đổi của bạn vào dự án🤞

Cập nhật nhánh làm việc cục bộ hiện tại của bạn với tất cả các commit mới từ nhánh tương ứng trên GitHub:

git pull

Cách đóng góp cho mã nguồn mở

Đầu tiên, hãy tìm một kho lưu trữ (hoặc repo) trên GitHub mà bạn quan tâm và muốn đóng góp một thay đổi. Bạn sẽ muốn sao chép nội dung của nó về máy của mình.

✅ Một cách tốt để tìm các repo 'thân thiện với người mới bắt đầu' là tìm kiếm theo thẻ 'good-first-issue'.

Có nhiều cách để sao chép mã. Một cách là "clone" nội dung của kho lưu trữ, sử dụng HTTPS, SSH, hoặc sử dụng GitHub CLI (Command Line Interface).

Mở terminal của bạn và clone kho lưu trữ như sau: git clone https://github.com/ProjectURL

Để làm việc trên dự án, chuyển đến thư mục phù hợp: cd ProjectURL

Bạn cũng có thể mở toàn bộ dự án bằng Codespaces, trình chỉnh sửa mã tích hợp / môi trường phát triển trên đám mây của GitHub, hoặc GitHub Desktop.

Cuối cùng, bạn có thể tải mã xuống dưới dạng một thư mục nén.

Một vài điều thú vị hơn về GitHub

Bạn có thể gắn sao, theo dõi và/hoặc "fork" bất kỳ kho lưu trữ công khai nào trên GitHub. Bạn có thể tìm các kho lưu trữ đã gắn sao của mình trong menu thả xuống ở góc trên bên phải. Nó giống như đánh dấu trang, nhưng dành cho mã.

Các dự án có một trình theo dõi vấn đề, thường là trên GitHub trong tab "Issues" trừ khi được chỉ định khác, nơi mọi người thảo luận về các vấn đề liên quan đến dự án. Và tab Pull Requests là nơi mọi người thảo luận và đánh giá các thay đổi đang được thực hiện.

Các dự án cũng có thể có các cuộc thảo luận trong diễn đàn, danh sách gửi thư, hoặc các kênh trò chuyện như Slack, Discord hoặc IRC.

✅ Hãy khám phá kho lưu trữ GitHub mới của bạn và thử một vài điều, như chỉnh sửa cài đặt, thêm thông tin vào repo của bạn, và tạo một dự án (như bảng Kanban). Có rất nhiều điều bạn có thể làm!

🚀 Thử thách

Hợp tác với một người bạn để làm việc trên mã của nhau. Tạo một dự án chung, fork mã, tạo nhánh, và hợp nhất các thay đổi.

Câu hỏi sau bài giảng

Ôn tập & Tự học

Đọc thêm về cách đóng góp cho phần mềm mã nguồn mở.

Git cheatsheet.

Luyện tập, luyện tập, luyện tập. GitHub có các lộ trình học tập tuyệt vời tại skills.github.com:

Tuần đầu tiên trên GitHub

Bạn cũng sẽ tìm thấy các khóa học nâng cao hơn.

Bài tập

Hoàn thành khóa học Tuần đầu tiên trên GitHub

Tuyên bố miễn trừ trách nhiệm:
Tài liệu này đã được dịch bằng dịch vụ dịch thuật AI Co-op Translator. Mặc dù chúng tôi cố gắng đảm bảo độ chính xác, xin lưu ý rằng các bản dịch tự động có thể chứa lỗi hoặc không chính xác. Tài liệu gốc bằng ngôn ngữ bản địa nên được coi là nguồn tham khảo chính thức. Đối với các thông tin quan trọng, chúng tôi khuyến nghị sử dụng dịch vụ dịch thuật chuyên nghiệp từ con người. Chúng tôi không chịu trách nhiệm cho bất kỳ sự hiểu lầm hoặc diễn giải sai nào phát sinh từ việc sử dụng bản dịch này.

22 KiB Raw Permalink Blame History