GitubSession

使用git為開源項目做出貢獻

歡迎來到我們的項目！我們很高興您正在考慮為開源開發做出貢獻。本指南將引導您介紹基本的git命令和最佳實踐，以使您的貢獻變得輕鬆而成功。

目錄

1. 分叉存儲庫
2. 克隆存儲庫
3. 創建一個分支
4. 進行更改
5. 進行更改
6. 推動變化
7. 創建拉力請求
8. 同步您的叉子
9. 寫出好消息的提示

---

1。分叉存儲庫

在開始貢獻之前，您需要為存儲庫提供。分叉在您自己的GitHub帳戶下創建存儲庫的副本。

步驟：

1. 導航到存儲庫頁。
2. 單擊頂端角上的“叉子”按鈕。
3. 現在，您將在GitHub帳戶中擁有存儲庫的副本。

---

2。克隆存儲庫

分配存儲庫後，您需要將其克隆到本地計算機上，以便可以使用它。

git clone https://github.com/your-username/repository-name.git

---

3。創建一個分支

克隆存儲庫後，創建一個新的分支來處理您的更改。始終在一個單獨的分支中工作，以避免與主要分支機構發生衝突：

git checkout -b feature/your-branch-name

---

4。進行更改

現在，您在分支機構中，對項目的代碼，文檔或其他部分進行必要的更改。在進行下一步之前，請確保測試所有內容。

---

5。進行更改

一旦您的更改完成，就該提交它們了。請按照以下步驟：

1. 將更改添加到分期區域：

git add .

2. 通過清晰而描述性的消息提交更改：

git commit -m " Your descriptive message here "

3. 確保您的提交信息清楚地說明了您所做的更改。

6。推動變化

在本地進行更改後，將分支推到GitHub存儲庫。

git push origin feature/your-branch-name

這會將您的分支上傳到Github上的分叉存儲庫。

7.創建拉動請求

隨著您的更改將其推向GitHub，您可以提交拉動請求（PR），以便維護者可以審查您的工作。

• 在GitHub上導航到您的分叉存儲庫。
  
• 單擊“比較和拉請求”按鈕。
  
• 提供您的更改標題和詳細描述。
  
• 提交拉動請求。
  
• 審查後，維護者要么合併您的PR或為修訂提供反饋。
  

8。同步叉

如果在工作時更新了原始存儲庫，則可能需要同步叉子以保持最新狀態。以下是：

1. 將上游存儲庫添加為遙控器：

git remote add upstream https://github.com/original-owner/repository-name.git

2. 從上游存儲庫中獲取最新更改：

git fetch upstream

3. 合併上游變化到您當地的主要分支：

git checkout main
git merge upstream/main

4. 將更新的主分支推到您的叉子：

git push origin main

9.寫良好的提交消息的提示

• 保持簡潔：瞄準一個不到50個字符的提交信息。
  
• 使用命令式的心情：例如，寫“修復錯誤”而不是“修復錯誤”。
  
• 提供上下文：包括問題編號或描述更改的目的。
  示例：修復＃42-解決用戶身份驗證中的錯誤。