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