Git的使用教程(十)擴展知識

    在新建遠程倉庫的時候,如果是個空倉庫,Git@OSC會引導你該如何操作,其中有一條建議是所有的git倉庫都有一個README,LICENSE,.gitignore文件。這些是什麼文件,有什麼作用,爲什麼每個git倉庫都要有呢,下面就跟隨小編一起來看看吧。

    

    README

    項目自述文件,讓用戶在使用之前對項目有個大致的瞭解。README文件至少要說明幾個問題,一、這是項目是用來做什麼的;二、如何使用;三、項目中重要的文件和目錄結構信息。如何編寫一個合格的README文件,一個合格的README應該包含哪些信息呢?

    1.說明創建項目的意圖

    2.項目的運行環境以及存在的可移植性問題

    3.哪些是運行項目必須的文件

    4.如果安裝和使用該項目

    雖然對於README的書寫內容沒有嚴格要求,但是爲了用戶使用方便,我們應該儘可能在README中把該項目介紹清楚。

    LICENSE

    項目許可證,通常指該項目的使用協議和服務條款等項目。

    .gitignore

    這個是小編重點想要介紹的一個文件,我們在使用的Git的時候很可能會用到它。它有什麼用?其實從名字不難看出來,git+ignore,也就是Git會忽視的東西。作爲版本控制系統,Git會記錄除了.git文件夾之外的所有文件的修改,但是有些文件的修改我們並不需要Git記錄,例如生成的靜態文件,這些靜態文件修改的頻率頗高,如果記錄它們的修改狀態,我們git status的時候永遠不會是一個乾淨的工作區,再說這些靜態文件也不具備記錄價值,因爲我們可以隨時使用動態程序重新生成,因此我們不需要對它們進行記錄,此時就可以把這些文件添加到.gitignore。

    例如我們存在一個不需要記錄的文件夾html,我們把html文件夾添加到.gitignore中,通過在html文件夾中新建文件來查看工作區的變化。

    .gitignore文件

 

html

 

 

    通過上圖我們可以觀察到,新建的test.html並沒有引起工作區的變化,可見我們的.gitignore文件生效了。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章