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分支展现本身的项目