https://github.com/techcell-project/.git-docs
Step to step to work with git
https://github.com/techcell-project/.git-docs
documentation markdown
Last synced: 5 months ago
JSON representation
Step to step to work with git
- Host: GitHub
- URL: https://github.com/techcell-project/.git-docs
- Owner: TechCell-Project
- License: mit
- Created: 2023-06-05T16:24:01.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-13T11:21:30.000Z (almost 3 years ago)
- Last Synced: 2024-05-05T19:38:05.472Z (almost 2 years ago)
- Topics: documentation, markdown
- Homepage:
- Size: 147 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github documentations for project
Step to step to work with git 🔥:
## 🚀 Lưu ý:
- Không làm việc tại các branch main, stable, development. Hãy tạo branch mới, làm việc tại đó.
- Cách đặt tên cho branch mới:
- Theo định dạng `_`.
- Với type là:
- Feature: Chức năng mới.
- Fix: Sửa lỗi.
- Refactor: Sửa lại định dạng, tổ chức lại code.
- Test: Kiểm, thử ...
- ...
- Và `name` là mô tả ngắn gọn cho mục tiêu
- (Ví dụ: `Feature_Auth_with_github` để thêm chức năng đăng nhập với github)
- Thường xuyên [git pull](#1-lấy-code-từ-github) để cập nhât phiên bản mới nhất của code trên github. Đặc biệt trước mỗi khi làm việc và push code hãy chạy [git pull](#1-lấy-code-từ-github)
- Xử lí [xung đột (conflict)](https://viblo.asia/p/lam-the-nao-de-han-che-conflict-khi-lam-viec-voi-git-djeZ1m8oZWz) sớm nhất có thể khi phát hiện
## 🚀 Step to works:
- Nếu **chưa** có repo, [clone repo](#1-lấy-code-từ-github) từ github
- [Đã có repo, xác định điều cần làm (feature, fix, ...)](#🚀-lưu-ý)
- **Không** sử dụng các branch `main`, `stable`, `development` để chỉnh sửa, hãy [tạo branch mới](#2-làm-việc-với-branch) và làm việc trên branch mới đó
- Kiểm thử
- [Commit](#3-commit) khi hoàn thành, và [push](#4-push) lên github
- Tạo **[Pull Request](#5-tạo-pull-request)** và nhờ người khác review code, đánh giá, kiểm thử.
- Chỉ tạo **[Pull Request](#5-tạo-pull-request)** để merge vào branch `development` hoặc branch khác mà không phải branch `main`, `stable`
# 🔥 Bắt đầu nhanh
### **1. Lấy code từ github:**
- Trường họp chưa có code trên máy:
- Clone git repository về máy bằng câu lệnh:
```bash
git clone
```
- Có thể đặt lại tên bằng cách thêm tên phía sau:
```bash
git clone
```
- Đã có code trên máy:
- Lấy code mới nhất trên github về:
```bash
git pull
```
### **2. Làm việc với branch:**
- Kiểm tra branch:
```bash
git branch
```
- Kiểm tra tất cả các branch:
```bash
git branch --all
```
- Tạo branch mới:
```bash
git branch
```
- Chuyển sang branch đã tồn tại:
```bash
git checkout
```
- Chuyển sang branch chưa tồn tại, và tự động tạo mới:
```bash
git checkout -b
```
- Để xóa branch, cần phải checkout sang branch khác branch cần xóa sau đó:
```bash
# nếu branch đã merge vào branch nào đấy rồi
git branch -d
# nếu branch chưa từng merge vào branch nào
git branch -D
```
- Lần đầu clone code có thể sẽ thiếu các branch phụ, mà chỉ có branch chính, như sau:
- Cách xử lí, ví dụ muốn vào branch tên là `development`:
```bash
git switch
# ví dụ
git switch development
```
### **3. Commit:**
- Để thêm các file muốn commit vào staged area. Bạn cũng có thể sử dụng git add . để thêm tất cả các thay đổi trong repository.
```bash
git add
#or
git add .
```
- Để kiểm tra trạng thái của staged area và các file trong working directory, sử dụng:
```bash
git status
```
- Để xem sự khác biệt giữa các file trong working directory và staged area, sử dụng:
```bash
git diff
```
- Khi đã staged các file, để commit các file (Lưu ý rằng commit message cần phải rõ ràng và mô tả đầy đủ các thay đổi trong commit), sử dụng:
```bash
git commit -m ""
```
- Nếu cần chỉnh sửa lại commit, sử dụng:
```bash
git commit --amend
```
- Để xem lại lịch sử commit của repository, sử dụng:
```bash
git log
```
### **4. Push:**
- Sau khi đã commit các thay đổi, bạn có thể đẩy chúng lên repository trên server bằng lệnh:
```bash
git push
```
- Lưu ý rằng trước khi push, bạn cần phải pull dữ liệu mới nhất từ server về bằng lệnh:
```bash
git pull
```
- Để đẩy các thay đổi lên branch hiện tại, sử dụng lệnh:
```bash
git push origin
```
- Nếu branch chưa được đẩy lên server trước đó, để đẩy branch và thiết lập upstream cho lần đẩy tiếp theo bạn có thể sử dụng lệnh:
```bash
git push --set-upstream origin
```
### **5. Tạo pull request:**
- Sau khi push thành công, truy cập vào repo trên github:
- Branch mới đã được push lên thành công, bấm vào branch vừa push, và chọn `Open Pull Request`:
- Chuyển sang `development`, không được merge vào `main` trừ khi là hot fix:
- Điền tiltle và comment để mô tả mục đích của branch muốn merger, sau đó chọn `Create Pull Request`:
### **6. Theo dõi Pull Request:**
- Nhớ theo dõi Pull Request để thảo luận về code của bạn ... 🔥