Home
>
企业 文档管理规范
>
github 文档管理
github 文档管理

time:2020-07-28 14:52:06

author:重庆佰鼎科技有限公司

【Font size: big medium smail

本文由重庆佰鼎科技有限公司提供,重点介绍了github 文档管理相关内容。重庆佰鼎科技有限公司专业提供企业 文档管理规范,产品需求文档 版本管理,电脑的文档管理器等多项产品服务。一直秉承诚信至上,产品优先,服务优先,客户优先原则,为您提供最优质的产品服务!

github 文档管理最近开通了微信公众号 欢迎大佬们关注一波 代码猎奇站

这是我在学习github的时候顺便写的教程,简单明了。

转载本文请准守 CC BY-NC-SA 4.0

转载本文请准守 CC BY-NC-SA 4.0

转载本文请准守 CC BY-NC-SA 4.0

2017.7.19更新

---------------------------------

添加新旧对比图

2016.9.24更新

-----------------------------------

在使用技巧中添加一条查看代码比例。

2016.8.28更新

-----------------------------------

添加GitHub for Windows使用教程(四)

主要是一些github使用技巧。

博客地址

GitHub for Windows使用教程(一)GitHub for windows使用教程(三)GitHub for windows使用教程(三)GitHub for Windows使用教程(四)

如若有错,还望指正。

更多文章 请看个人博客 ↓

ISLAND

如果你还不知道什么是git,只知道github,但是还不会用,我想这个教程会帮助你。

前言

鉴于网上目前的教材都太落后,github for windows已经更新了多个版本,好多界面都发生了变化,所以来写这个教程。目的是为了帮助和我一样初学github,但是苦于找不到教程的同学,为了写最详细的教程。配备了大量的图文介绍。该教程是基于GitHub for windows (3.0.17.0)

注:github 文档管理

由于教程为 3.0.17.0 ,之后github对客户端进行了新版的更新,这里的图为新版与旧版对比。希望可以给大家带来帮助。

什么是Github

说到什么事github,我们先看wikipedia的描述“GitHub是一个利用Git进行版本控制、专门用于存放软件代码与内容的共享虚拟主机服务。它由GitHub公司(曾称Logical Awesome)的开发者Chris Wanstrath、PJ Hyett和Tom Preston-Werner使用Ruby on Rails编写而成。”

准备工作

下载github for windows,安装这里不赘述。注册github账号

登陆到github for windows。

准备工作都完了,我们开始正式学习。^_^

创建第一个代码库

认识界面

github for windows的界面非常清爽,的确符合geek的性质,个人表示非常喜欢。 我们来建立第一个仓库,点击左上角的+号,初次建立他会有一圈圈的涟漪,非常漂亮哦。 打开之后有三个选项,Add,Create,Clone。 我们分别来介绍一下这三个功能。

Add功能

如果本地有工程,就可以使用Add添加

Clone功能

这个功能其实最好理解了,克隆这名字通俗易懂好理解。 如何使用Clone功能呢? 就是将在浏览器上已经创建好的项目导入到本地,换句话说就是下载到本地。

Create功能

创建一个代码库, Name填写你的仓库名字。Local path写你将要保存在本地路径。

我们主要从这个功能开始github之旅。 我们在这里填写First,来创建第一个我们自己的repoeitory。 github 文档管理

开始使用第一个代码库

修改第一个代码库中内容

我们来找到刚刚创建的代码库在本地的位置。就是刚刚在local path的地址路径,当然如果你忘了,请右键点击First。

选择Open in Explorer。这样我们就可以转到刚刚的路径下。 我们新建一个文本文档。在里面编辑。 如下

此时的github就会变成这个样子(Changs):

你会发现此时github会出现刚刚编辑的内容。

这个是测试文本你好 并且前面会有蓝色标识,那么这个蓝色标识是什么用呢?

其实这个蓝色标识是提示你会上改变的文本。比如我第一次只想改变 这个是测试文本并不想把你好上传。 这时我们点击一下你好的前面的蓝色标识。

你会发现你好前面的蓝色标识没有了。

我们填写好Summer和Description Summer就是这次改动的总结,我们也可以理解为标题*(必填),而Description可以理解为详细概况(选填)*

我们这里只选择第一个修改对象,也就是这个是测试文本就行修改。summer我们填写为第一次修改,Description我们填写为增加了这个是测试文本的内容,之后点击Commit to master。

切换到History目录下 我们会发现他改变了。 这次我们把你好进行添加。

在History目录下发生了这样的改变。会在History目录下形成一天时间线,来指出每一次的修改标题和内容,同时会把修改的内容用绿色标识标出。 我们打开本地的文本,删除刚刚添加的第一行这个是测试文本。

此时你就会发现github发生了变化。 此时的红色标识标识删除。我们写好Summer和Description并点击Commit to master。 这样我们就删除了第一行。同时在History目录下又多了一条时间轴。

这样我们就完成了删除。

上传与同步

上传

此时,当我们打开github网页,就会发现此时你的修改的内容并没有出现在这里。这是因为你没有进行同步,仅仅是在本地就行了修改。此时我们仅仅需要点击右上角的publish

此时你就会本地内容已经上传到网页上。

同步

当你的代码库上传后就会发现,原来的publish以及变为了Sync。 点击Sync同步代码库!

分支的使用

创建分支

我们创建第一个分支取名为new masterh,点击Create new branch创建第一个分支。

我们发现此时的分支已经切换到了我们刚刚创建的分支new masterch 。

我们来修改new masterch分支上的内容。 我们仍旧打开FirstDemo.txt进行编辑。输入以下内容

创建的第一个分支。打开github进行,填写Summary和Description

之后我们点击Commit to new-master在History目录下,我们可以看到会有两条主线,分别是master和new-master并且在new-master的分支下又一个蓝色的实线空心圈和一个虚线空心圈。

实线圈表示当前的节点,空心圈表示下一次修改时的节点。

红线标示的部分就是当前的分支

切换分支

点击红色划线部分就会出现分支的列表

我们点击master就会切换到master分支。

上传/同步分支

这个操作和同步仓库是一个操作,点击Publish/Sync上传或同步分支。

删除分支

首先要把分支切换到你要删除的分支下,如我们要删除new master,将分支切换到new master

点击右上角齿轮就会出现Delete new master 点击Delete new master就会弹出一个对话框,询问删除的内容。

第一个yes ,Delete both是将本地与网页全部删除;

第二个Delete local only仅仅是删除本地。

第三个是取消。

合并两个分支

将一个分支与master分支进行合并。 我们首先把分支切换到master下,点击Update from new-branch进行分支的合并。

此时我们查看history目录下就会

团队协作流程

认识Flow

GitHub Flow是一个轻量级的,基于分支的工作流程,支持团队和部署在那里的定期做项目。

为团队成员写入权限

在我们的队友添加一个写的权限,这样我们的队友才能很好的修改代码。 我们打开网页上的GitHub,点击settings,

之后我们找到collaborators,这里会让我们验证密码,之后就有添加合作者的选项。

这样我们就能添加我们的小伙伴了! 这样我们就添加了新的小伙伴,新的小伙伴有着同样的权限去修改和管理代码。 此时我们就会看到我的小伙伴wevan的github主页上就会出现关于我创建的First的各种通知。

创建分支

在我们创建一个叫add new function的分支。

创建一个分支 Create a branch 当你工作的一个项目,你会在任何给定的时间有一堆不同的功能或正在进行的想法 - 其中一些是蓄势待发,而另一些则不是。分支的存在是为了帮助你管理这个工作流程。 When you're working on a project, you're going to have a bunch of different features or ideas in progress at any given time – some of which are ready to go, and others which are not. Branching exists to help you manage this workflow. 当您在项目中创建一个分支,你创造一个环境,在那里你可以尝试新的想法。你让一个分支的更改不会影响主分支,让你可以自由进行实验,并提交更改,在你的分支将不会被合并,直到它准备好知识安全的人所正在与合作进行审查。 When you create a branch in your project, you're creating an environment where you can try out new ideas. Changes you make on a branch don't affect the master branch, so you're free to experiment and commit changes, safe in the knowledge that your branch won't be merged until it's ready to be reviewed by someone you're collaborating with. ProTip 分支在Git中是一个核心概念,整个GitHub的流量是基于它。这里只有一个规则:在任何主分支总是部署。 Branching is a core concept in Git, and the entire GitHub Flow is based upon it. There's only one rule: anything in the master branch is always deployable. 正因为如此,这是非常重要的一个功能或修复工作时,你的新分支关老爷的创建。您的分支名应该是描述(例如,重构的身份验证,用户的内容缓存键,使视网膜-化身),以便其他人可以看到正在处理。 Because of this, it's extremely important that your new branch is created off of master when working on a feature or a fix. Your branch name should be descriptive (e.g., refactor-authentication, user-content-cache-key, make-retina-avatars), so that others can see what is being worked on.来自GitHub Flow

添加提交

我们首先把分支切换到新的分支上add new function

修改新的版本

填写好新的Summary和Description,提交新的版本并同步。 这样小伙伴登陆到GitHub上就看到了就可以清楚的看到一切的修改。

添加提交 Add commits 一旦你的分支已经建立,现在是时候开始进行更改。无论何时添加,编辑或删除一个文件,你作出承诺,并将其添加到您的分支。提交加入这一过程保持你的进步轨迹,你在一个特性分支工作。 Once your branch has been created, it's time to start making changes. Whenever you add, edit, or delete a file, you're making a commit, and adding them to your branch. This process of adding commits keeps track of your progress as you work on a feature branch. 还承诺创建工作的透明历史,其他人可以按照理解你做了什么,以及为什么。每次提交都有一个关联的提交信息,这是解释为什么一个特定的变化作出了说明。此外,每次提交被认为是变革的一个独立单元。这使您可以回滚的变化,如果发现错误,或者如果你决定在一个不同的方向前进。 Commits also create a transparent history of your work that others can follow to understand what you've done and why. Each commit has an associated commit message, which is a description explaining why a particular change was made. Furthermore, each commit is considered a separate unit of change. This lets you roll back changes if a bug is found, or if you decide to head in a different direction. ProTip提交信息是重要的,特别是因为Git跟踪更改,然后将它们显示为承诺一旦他们推到服务器。通过字迹清晰提交信息,你可以更容易为其他人跟着,并提供反馈。 Commit messages are important, especially since Git tracks your changes and then displays them as commits once they're pushed to the server. By writing clear commit messages, you can make it easier for other people to follow along and provide feedback.来自GitHub Flow

打开一个pull请求

这个是整个流程中比较关键的一步,发布Pull Request。

点击客户端或者网页上的Pull Request发布。 我们这里点击Pull Request

我们填写好必要的说明性文字 点击Send Pull Request 他既然让我们到GitHub上看,我们就听他的,点击,进入。

我们发现小伙伴已经在下面留言了!

讨论和审核你的代码

你的小伙伴开始对你的代码讨论,修改,迭代。

讨论和审查你的代码 Discuss and review your code 一旦拉入请求已被打开,人或团队审查您的变化可能有疑问或意见。也许编码风格不匹配项目的指导方针,改变缺少单元测试,或者也许一切看起来不错,道具都是为了。引入请求旨在鼓励并捕获这种类型的对话。 Once a Pull Request has been opened, the person or team reviewing your changes may have questions or comments. Perhaps the coding style doesn't match project guidelines, the change is missing unit tests, or maybe everything looks great and props are in order. Pull Requests are designed to encourage and capture this type of conversation. 您还可以继续推送到你的分支在你提交的讨论和反馈光。如果有人评论说,你忘了做某件事,或者如果在代码中的错误,你可以在你的分支修复它,推高的变化。GitHub上会显示新的提交和其他任何意见,你可能会收到统一拉请求视图。 You can also continue to push to your branch in light of discussion and feedback about your commits. If someone comments that you forgot to do something or if there is a bug in the code, you can fix it in your branch and push up the change. GitHub will show your new commits and any additional feedback you may receive in the unified Pull Request view.ProTip 拉请求的意见都写在降价,所以你可以插入图片和表情符,使用预先格式化的文本块,等轻质格式。 Pull Request comments are written in Markdown, so you can embed images and emoji, use pre-formatted text blocks, and other lightweight formatting.部署

部署 Deploy 一旦你拉的请求进行了审查和部门通过你的测试,您可以部署您的更改,以验证他们的生产。如果你的分支造成的问题,您可以通过部署现有的主投产回滚 Once your pull request has been reviewed and the branch passes your tests, you can deploy your changes to verify them in production. If your branch causes issues, you can roll it back by deploying the existing master into production.合并

合并分支我们之前已经说过,这里就不再赘述。

合并 Merge 现在,您的更改在生产中得到了验证,现在是时候你的代码合并到主分支。 Now that your changes have been verified in production, it is time to merge your code into the master branch. 合并后,引入请求保护的历史变迁到您的代码记录。因为他们是搜索的,他们不让任何人回去的时间理解为什么以及如何决定了。 Once merged, Pull Requests preserve a record of the historical changes to your code. Because they're searchable, they let anyone go back in time to understand why and how a decision was made.ProTip 通过将某些关键字到您的拉请求的文本,你可以用代码相关联的问题。当你拉入请求合并,相关问题也将被关闭。例如,输入短语关闭#32将关闭在仓库中发行数量32。欲了解更多信息,请查看我们的帮助文章。 By incorporating certain keywords into the text of your Pull Request, you can associate issues with code. When your Pull Request is merged, the related issues are also closed. For example, entering the phrase Closes #32 would close issue number 32 in the repository. For more information, check out our help article.

基本的一些用法就完成了。看着这个操作一遍基础就差不多了。

这个知乎的编辑啊…………好累

----------------------------------------------------------------------------------------------------------------

在上述的几个教程里讲解了一些Github的基础使用,现在开始讲解一些使用技巧。

查找内容

在github页面上是没有搜索的按钮,如何搜索呢。 在网页上按T就会出现。 这样我们就能很方便的查找到我们需要的代码了。

评论小表情

常常在版本描述或者pull request时我们需要对伙伴的代码进行一下评论与说明,光是文字有点很死板,其实github给我有emoji,如何使用呢?其实很简单,只需要冒号就可以 :

这样我们就可以看到emoji表情,当然默认会显示五个常用的,你也可以继续敲下emoji的名字,出现更多(这里有所有的表情)。

忽略不想上传的文件

有些在github中的文件我们是不想上传的,我们如何过滤掉它们呢? 在github中对不想上传的文件点击右键。就会出现下面选项。 Ignore file忽略这个文件 Ignore all.txt files 忽略所有的以.txt结尾的文件 这样就可以过滤掉你不想上传的文件

搜索项目

如何高效的搜索一个你想要的库呢? 我们常常评判一个项目的标准有star数目,fork数目和跟新时间。 通过搜索命令

stars

stars:>1000表示star数目大于1000。

fork

fork:>1000表示fork数目大于1000。

语言搜索

java,html等等

综合一下就是,比如你要查找一个stars大于1000的,fork大于200的java代码。

stars:>1000 fork:>200 java

就是这样。

查看项目中的语言类型

一个项目中,可能使用了多种语言,我们如何一下子就能看到一个项目使用了什么语言?其实很简单,Github已经为我们统计好了。

也行你注意过,但是没有发现它有什么用。

点击下面的彩条

github已经为我们统计好这个项目所有的语言及其比例。

总结

码字不易,终于写完了,如果觉得对你有帮助,我的目的就达到了。

谢谢

如有错误,还望指正。

不要光收藏,点个赞

转载请通知作者!

谢谢

其他相关阅读

Git基本操作Git教程及使用经验更多文章 欢迎关注个人微信公众号

代码猎奇站

Reprint please indicate:http://www.cnsoftweb.com/wdgl-3343.html