- 1. GitHub 的Hello World教程
- 2. 参考链接
1. GitHub 的Hello World教程
翻译自
https://guides.github.com/activities/hello-world/
内容有精简和补充,开头部分增加了重要流程和概念的介绍。
为了便于实际使用github,熟悉界面单词, 每个步骤的标题没有翻译,采用其特有的术语,对应的要素在第一次提到时都给出了中文所对应的英文。
1.1. 什么是GitHub?
GitHub是版本控制和协作的代码托管平台。它可以让你和其他人在任何地方一起工作。
本教程向您介绍GitHub 基本要素,如存储库(repository),分支(branches),提交(commits)和合并请求(Pull Requests)。
您将创建自己的Hello World存储库并学习GitHub的Pull Request工作流程,这是一种创建和查看代码的流行方式。
无需编码
为了完成这个教程,你需要一个GitHub.com 账号 和Internet的访问, 不需要知道如何编码,使用命令行或者安装Git(GitHub 构建其上的版本控制软件)
提示:在单独的浏览器窗口(或选项卡)中打开本指南,以便在完成教程中的步骤时看到它。
1.1.1. 安全试验和修改的核心:Branching & Pull Requests
使用github最重要的概念是分支合并流程:
有了分支,可以很安全第进行修改和增加新特性。
- 创建分支,可以在分支里安全地实验和修改。
- 打开一个合并请求,从其他人那里得到反馈。
- 部署代码测试,合并修改到主分支。
1.1.2. 社会协作编码的核心:Forking
另一个需要了解的概念是Forking Projects
在自己使用GitHub一段时间后,您可能会发现自己想要为其他人的项目做出贡献。或者,也许你想用某人的项目作为自己的起点。这个过程被称为分叉(forking)。
创建一个“分叉”就是制作其他人项目的个人副本。叉子(forks) 充当原始存储库和个人副本之间的桥梁。您可以提交合并请求Pull Requests,通过将更改提供给原始项目来帮助改善其他人的项目。分叉Forking 是GitHub社会协同编码的核心。
限于篇幅,请自行到参考资料中查看,本文不作具体说明。
1.2. 第1步. Create a Repository
一个库Repository通常用于组织单个项目。存储库可以包含文件夹和文件,图像,视频,电子表格和数据集 - 您的项目需要的任何东西。我们建议包括一个自述文件或包含关于您项目信息的文件。GitHub可以在创建新存储库的同时轻松添加一个。它还提供其他常见选项,如许可证文件。
您的hello-world存储库可以是您存储想法,资源甚至与其他人共享和讨论事物的地方。
创建一个新的存储库
在右上角,在你的头像或身份证旁边,点击 然后选择新的存储库。
命名您的存储库hello-world。
写一个简短的描述。
选择使用自述文件初始化此存储库。
1.3. 第2步. Create a Branch
分支Branching 是一次处理不同版本的存储库的方式。
默认情况下,你的仓库中有一个分支master,它被认为是最终分支。在提交之前,我们使用分支来进行实验和编辑master。
当您从分支创建分支时master,您正在制作master当时的副本或快照。如果其他人在master分支上工作时对分支进行了更改,则可以引入这些更新。
此图显示:
- 该master分支
- 一个新的分支叫feature(因为我们正在这个分支上做'feature工作')
- feature合并至master之前的过程
分店
你有没有保存过不同版本的文件?就像是:
- story.txt
- story-joe-edit.txt
- story-joe-edit-reviewed.txt
分支Branches 在GitHub存储库中实现类似的目标。
在GitHub上,我们的开发人员,作家和设计人员使用分支机构将错误修复和功能工作与我们master(生产)分支分开。当一个变化就绪后,他们再将分支合并到master。
1.3.1. To create a new branch
- 转到您的新存储库hello-world。
- 单击文件列表顶部的下拉列表中的分支:master。
- readme-edits在新的分支文本框中输入分支名称。
-
选择蓝色的创建分支框或点击键盘上的“Enter”键。
现在你有两个分支,master并且readme-edits。它们看起来完全一样,但时间不长!接下来,我们会将我们的更改添加到新分支。
1.4. 第3步. Make and commit changes
好样的!现在,您在您的readme-edits分支的代码视图中,它是master的副本。我们来做一些编辑。
在GitHub上,保存更改被称为提交commit。每个提交都有一个关联的提交消息commit message,它是解释为什么进行特定更改的说明。提交消息捕获您所做更改的历史记录,所以其他贡献者可以了解您所做的工作以及原因。
1.4.1. Make and commit changes
- 点击该README.md文件。
- 点击 铅笔图标在文件视图的右上角进行编辑。
- 在编辑器中,写一些关于你自己的信息。
- 编写描述您的更改的提交消息。
-
单击提交更改按钮。
这些更改将仅针对readme-edits分支上的readme文件进行,因此现在该分支包含与master不同的内容。
1.5. 第4步. Open a Pull Request
现在您已经在主分支之外进行了更改,你可以开始合并请求Open a Pull Request。
合并请求(Pull Requests)是GitHub协作的核心。当你打开一个合并请求时,你提出了你的改变,并要求有人审查并提交你的贡献,并将它们合并到他们的分支中。合并请求显示来自两个分支的内容的差异。更改,添加和减法以绿色和红色显示。
一旦你提交了,你甚至可以在代码完成之前打开一个合并请求并开始讨论。
通过在您的合并请求消息中使用GitHub的 @mention system ,您可以要求特定人员或团队提供反馈,无论他们是否在大厅或10个时区以外。
你甚至可以在自己的仓库中打开合并请求并自己合并。在开始大型项目之前,学习GitHub流程是一种很好的方式。
1.5.1. Open a Pull Request for changes to the README
-
点击 合并请求 标签,然后从合并请求页面点击绿色的新建请求按钮。
在“ 示例比较”框中,选择您创建的分支readme-edits以与master(原始)进行比较。
- 查看比较页面上差异的更改,确保它们是您想要提交的内容。
-
如果您满意这些是您要提交的更改,请点击绿色的“ 创建合并请求”按钮。
-
为您的拉取请求提供一个标题并写下您的更改的简要说明。
1.6. 第5步. Merge your Pull Request
在这最后一步中,是时候把你的修改结合起来 - 将你的readme-edits分支合并到master分支中。
- 点击绿色 合并拉请求(Merge pull request ) 按钮,将更改合并到master。
- 点击确认合并。
- 继续操作,并删除分支,因为它的更改已经合并,并在紫色框中带有删除分支按钮。
庆祝!
通过完成本教程,您已经学会了创建一个项目并在GitHub上提出合并请求!
以下是您在本教程中完成的任务:
- 创建了一个开源库
- 开始并管理一个新的分支
- 更改了一个文件并将这些更改提交给GitHub
- 打开并合并了一个合并请求。
2. 参考链接
Hello World
https://guides.github.com/activities/hello-world/
Understanding the GitHub Flow
https://guides.github.com/introduction/flow/
Forking Projects
https://guides.github.com/activities/forking/