git+Github的正確姿式

前言

此文章是筆者在 github 使用中的一些經驗性總結，學習的新姿式會同步更新，記錄。

學習資料

1. 新手推薦

• Git教程-廖雪峯
• 版本控制入門 – 搬進 Github

2. 幫助文檔

• Git --fast-version-control
• 官方網站 / 基礎中文翻譯
• Git飛行規則(Flight Rules)
• GitHub祕籍
• GotGitHub: an open source E-book about GitHub in Chinese
• git-recipes - 高質量的Git中文教程
• GitHub 漫遊指南 by phodal

1、github markdown語法介紹

寫好 md 很重要 !!!

• 中文技術文檔的寫做規範 by ruanyifeng
• guodongxiaren/README README文件語法解讀
• emoji-list/ github支持的emojj表情

2、保證基本使用

1. 在公司的內網如須要配置代理

github上能夠使用https進行訪問。

$ git config --global http.proxy http://web-proxy.oa.com:8080

可是這樣能夠clone了。可是若是要push代碼，那就麻煩了。每次都須要輸入密碼,接着往下看。

2. 上傳前設置.gitignore 過濾

案例介紹，如前端 項目中充滿數量龐大依賴文件的node_modules，咱們不須要上傳，靠package.json文件下載依賴包就能夠

*.DS_Store
node_modules # 過濾項目中名爲 node_modules 的文件夾，作上傳例外操做
bower_components
.sass-cache
npm-debug.log
.idea
.vscode

# git-忽略版本控制內某些文件的修改
git update-index --assume-unchanged application/Everything/Everything.ini

3. git commit log

優雅的提交 code，爲 commit 本身的每次 commit 設置好的日誌, 方便往後追溯:

• Head

  • type: feat 新特性, fix 修改問題, docs 文檔, style 格式, refactor 重構, test 測試用例, chore 其餘修改, 好比構建流程, 依賴管理.
  • scope:影響範圍， 好比: route, component, utils, build... 可省略
  • subject:簡短的提交信息

• Body

  • what：詳細作了什麼
  • why： 爲何這樣作
  • how： 有什麼後果

• Footer

  • 相關連接

補充：使用 svn 小烏龜提交代碼沒有強制須要寫 commit log , 建議你們都寫

4. git push免密碼

每次提交代碼時須要輸入用戶名密碼，則說明你在從倉庫中clone代碼時使用的是HTTPS的key進行拉取代碼。而使用SSH key拉取代碼時，則不須要。

(1). 建立文件 .git-credentials 存儲GIT用戶名和密碼

# 建立
touch .git-credentials
# 在vim中打開 
vim .git-credentials
# 文件內容 
https://{username}:{password}@github.com

(2). 長期存儲密碼,進入git bash終端， 輸入以下命令:

git config --global credential.helper store

通過這樣操做後就能夠免密登陸了

注意事項

文件結構要與初始化鏈接 github 的.gitconfig文件在同級別目錄下

3、項目 github 平臺展現

1. gh-pages 分支發佈在線訪問

在本身的github項目上添加gh-pages分支，並保證裏面有須要展現的代碼，以index.html做爲入口就ok，能夠展現項目了

• 參考：將本項目下的 dist 文件夾內容發佈到遠端的 gh-pages 分支

git subtree push --prefix=dist origin gh-pages

栗子

• 項目 vip 在線訪問
• 項目 react-yanxuan 在線訪問

2. github 修改項目語言顯示

在項目根目錄添加文件名爲.gitattributes的文本文件:

touch .gitattributes

寫入:

*.js linguist-language=javascript
*.css linguist-language=javascript
*.html linguist-language=javascript

意思就是將.js、.css、.html看成 javascript 語言來統計,簡單有效

查看案例，將展現的語言變爲 javascript=> King-of-glory

3. 上傳文件出錯

(1). git 推送出現 "fatal: The remote end hung up unexpectedly"

緣由：上傳的文件過大,單個文件均小於 100M
解決辦法：在項目.git文件夾下尋找config文件，添加以下代碼：

[http]
postBuffer = 524288000

(2). 用於上傳單個文件大於100M失敗時使用

• git-lfs

參考連接

• 優雅的提交你的 Git Commit Message
• Git 提交的正確姿式：Commit message 編寫指南
• 如何用Github的gh-pages分支展現本身的項目