最流行開源代碼倉庫, GitHub創建項目示例

從最經典的hello word 開始.

學習:

  • 創建使用倉庫
  • 創建管理分支
  • 修改提交文件
  • 創建合併拉取請求

GitHub是什麼?

GitHub是一個用於版本控制和協作的代碼託管平臺。

這個示例主要介紹 倉庫,分支、提交、 拉取請求. 創建一個hellworld項目,演示開源項目拉取合併工作流程,最流行的代碼審查工具。

自己操作 需要先在GitHub.com 註冊一個賬號。

步驟 1:創建倉庫

一個倉庫包含一個項目. 倉庫開源包含文件夾 文件 圖片 視頻等任何項目需要的文件。

推薦在根目錄創建README文件,包含一些項目的介紹信息。

這個helloworld 倉庫可用用來保存你的想法、資源、或者任何和其他人討論分享的東西。

創建倉庫

  1. 在右上角你頭像旁邊 點擊+ New repository.
  2. 填寫你倉庫的名字 hello-world.
  3. 填寫簡單描述信息.
  4. 選擇用 README初始化項目。
最流行開源代碼倉庫, GitHub創建項目示例

點擊 Create repository.

步驟 2. 創建分支

分支可以在同一個倉庫同時保存多個版本。

默認倉庫有一個master 主分支,我們用分支來做一些實驗的功能,修改測試後在提交到主分支。

在主分支創建分支的時候,分支是master一個快照。

這裡有個圖:

  • 最開始是master主分支
  • 然後創建一個feature分支,我們將在這個分支開發新功能
  • feature分支顯示了整個開發過程,最後合併到master分支上。
最流行開源代碼倉庫, GitHub創建項目示例

你有保存過不同版本的文件嗎 例如:

  • story.txt
  • story-joe-edit.txt
  • story-joe-edit-reviewed.txt

分支實現了類似效果.

在GitHub上,開發者在分支上寫代碼 做設計 開發新功能或者修復bug,當開發完成後分支將合併到master主分支上。

創建一個分支

  1. 點擊進入創建倉庫 hello-world.
  2. 點擊下拉列表框 branch: master.
  3. 輸入分支名稱 readme-edits.
  4. 選擇 Create branch 選項 或者 輸入 回車 鍵.
最流行開源代碼倉庫, GitHub創建項目示例

現在有兩個分支了 master 和 readme-edits. 現在他們是完全相同的,我們將在新分支上面修改文件。

步驟3. 修改並提交

現在你在readme-edits分支的查看代碼,接下來我們做一些修改.

在GitHub,保存修改操作叫做 commit (提交),每個提交關聯一個提交消息,用來描述修改的內容,提交消息保存每次修改的歷史記錄,因此其他人可以通過歷史記錄,看懂你在做什麼操作。

修改提交

  1. 點擊 README.md 文件.
  2. 點擊 右上角的 鉛筆工具 ,打開編輯器
  3. 在編輯器裡面 隨便寫一些介紹信息.
  4. 在下面寫上此次修改提交描述信息.
  5. 點擊按鈕 Commit changes .
最流行開源代碼倉庫, GitHub創建項目示例

提交後 readme-edits的 README 文件將會被修改,和主分支不一樣了。

步驟 4. 創建一個 Pull Request

現在你在主分支外的另一個分支修改了文件內容,

下面可以創建一個pull Requests,把修改合併到主分支上。

Pull Requests 是GitHub 代碼協作的核心。創建pull request表示你將提交你的修改並請求別人review 拉取你的貢獻,併合併到 主分支上面。

pull request 會顯示你的修改內容, 增加的 或者減少,用綠色或者紅色顯示。

提交commit後,你就可以立即創建一個pull request .

可以用GitHub @ 功能 在創建pull request希望得到某人的反饋 ,

你也可以自己review pull request,自己合併,練習下整個流程。

打開一個修改README 的Pull Request

點擊圖片打開大圖

點擊 Pull Request 標籤, 點擊

New pull request 按鈕.

最流行開源代碼倉庫, GitHub創建項目示例

選擇分支 readme-edits, 和 master (主分支) 比較.

最流行開源代碼倉庫, GitHub創建項目示例

在比較頁面查看修改內容,確認是需要提交的修改。

最流行開源代碼倉庫, GitHub創建項目示例

如果滿意此次修改,點擊 Create Pull Request按鈕

最流行開源代碼倉庫, GitHub創建項目示例

填寫 pull request 請求標題,和簡短描述信息

最流行開源代碼倉庫, GitHub創建項目示例

點擊Create pull request

步驟 5. 合併 Pull Request

最後一步, 把所有修改合併到主分支 master上面

  1. 點擊綠色 按鈕 Merge pull request 合併修改到master分支.
  2. 點擊 Confirm merge.
  3. 合併後可以刪除readme-edits分支,因為已經合併步在需要此分支,點擊紫色框內 Delete branch 按鈕.
最流行開源代碼倉庫, GitHub創建項目示例
最流行開源代碼倉庫, GitHub創建項目示例

總結!

通過這個示例,學習到如何在GitHub創建項目,創建 pull request 。

包括:

  • 創建打開一個項目
  • 開始管理一個分支
  • 修改提交一個文件
  • 打開合併一個 Pull Request

打開你的GitHub profile,將會看到新創建的開源項目。

詳細的git命令使用,可參考其他文檔。


分享到:


相關文章: