GitHub 倉庫
這一節,我將帶領大家一步一步創建一個代碼倉庫,然后了解一下倉庫里面有哪些常用的特性和功能。
1. 創建倉庫
大家可以根據下面的這張圖片來學習創建 GitHub 倉庫的幾個主要步驟。
- 點擊 “New repository” 進入項目創建頁面;
- 填寫項目名稱(必須),一般起一個簡單的英文名;
- 填寫項目描述(非必須), 可以簡單描述一下項目功能之類的;
- 選擇你要創建的是私人倉庫還是公共倉庫,如果你選擇創建公共倉庫,那么你的項目每個人都可以看到,如果是私人倉庫,只有你和你所指定的人才可以看到;
- 選擇是否需要生成 readme 文件,待會我會介紹這個 readme 文件是干嘛的;
- 選擇添加 gitignore 和 license 文件,gitignore 文件的作用是配置一些你在本地開發時無需上傳到遠程代碼倉庫的文件,license 就是證書文件,一般可以不添加,或者添加 MIT license;
- 點擊 “Create repository” 確認創建。
2. 倉庫結構
接下來讓我們看一下代碼倉庫的界面,看看界面上有哪些我們需要關注的信息和功能。
重點看下我標注的這些模塊,我會一一講解這些模塊的功能:
- Used by: 展示了這個項目被 github 上其他項目使用的次數,例如圖中的 React 是個知名的前端庫,所以使用者眾多;
- Watch: 點擊 Watch 后,相當于你就關注了這個項目,那么以后要是這個項目有更新,你就會收到提醒;
- Star: 類似朋友圈點贊功能,你覺得這個項目不錯,就可以給它點贊;
- Fork: 拷貝一份項目到你自己的倉庫,不過如果原倉庫后面有更新,你自己的倉庫不會自動更新代碼,需要通過其他方式同步過來才行。
- Issues: 當你在使用公共庫發現了 bug 或者有疑惑的時候,就可以在 Issues 模塊提出問題,等待倉庫作者或者其他使用了這個倉庫的開發者來解答;
- Pull requests: Pull request 列表,Pull request 簡稱 “PR”,意思是向這個倉庫提交代碼合并請求;
- 描述: 之前創建倉庫時填寫的描述會展示在這里;
- commits: 代碼提交記錄;
- branches: 代碼分支;
- releases: 代碼發布的歷史版本可以在這里找到;
- contributors: 倉庫的貢獻者,只要你向這份倉庫貢獻過代碼,就會出現在這個列表里面;
- 顏色條: 倉庫中所用到的各種代碼語言占比;
- Branch: 點擊這里可以切換不同的分支,圖中可以看到現在是 master 分支;
- New pull request: 創建一個代碼合并請求;
- Clone or download: 使用 git clone 項目倉庫,或者直接下載項目壓縮包。
接下來,我會介紹上面其中幾個功能的妙用和小技巧。
2.1 Used by 妙用
點擊 Used by,我們可以看到如下界面:
可以看到使用這個開源庫的項目列表,點擊右邊的數字還可以看到更加詳細的列表。有時候我們想要使用某個開源庫,但是它的項目文檔寫的不怎么友好,看完文檔還是會有疑惑,不知道怎么正確使用。這時候,我們就可以點擊列表上使用過這個開源庫的項目,多打開幾個,對比一下別人怎么使用的,然后再總結應用到自己的項目中。
2.2 Watch 和 Star
這里之所有把這兩個放在一起講,是因為他們的功能有類似的地方,都是相當于關注了這個項目。但是又有很大不同,當你 Watch 這個項目后,表示你以后會關注這個項目的所有動態,以后這個項目有任何變動,都會提示你,如果你設置了個人郵箱,還會給你發郵件,而 Star 就不會。
其實最早的時候 Github 是只有 Watch 的,然后發現很多人 Watch 項目只是拿來當收藏夾用的,于是就有了 Star,所以現在你清楚怎么使用這兩個功能了吧。
- 如果你想關注這個項目,后續想要第一時間獲取到項目的最新動態,就 Watch 它吧;
- 如果你只是想收藏它,方便以后快速查找,就 Star 它。
2.3 Releases
點擊進入 Releases 模塊界面:
在這個界面,我們可以看到每個版本更新了哪些內容,修復了哪些 Bug,以了解開源庫的版本信息。
3. 倉庫介紹
一個好的開源項目倉庫,肯定需要一個好的項目介紹文檔,來說明這個項目到底是干啥的,怎么使用等。這個時候 Readme 文檔就發揮重要作用了。Readme 文檔里面的內容會出現在倉庫首頁,項目目錄的下方,一目了然,我們在看開源庫的時候一般第一時間就是通過看他的 Readme 文檔來了解這個項目。
4. 總結
學習了這一節后,同學們可以在 Github 上創建一個屬于自己的倉庫哦,取一個簡單而有意義的項目名稱,寫上一段簡短的描述,先寫一個初始化的 Readme 文檔,后續再補充完善。