Technical Note GitHub 协同开发指南 ( 指令版 ) AMetal 平台协同开发 TN V1.00 Date:2018/08/21 工程技术笔记类别内容关键词 GitHub,AMetal 摘要本文介绍如何使用 GitHub 来进行 AMetal 的协同开

Size: px

Start display at page:

Download "Technical Note GitHub 协同开发指南 ( 指令版 ) AMetal 平台协同开发 TN V1.00 Date:2018/08/21 工程技术笔记类别内容关键词 GitHub,AMetal 摘要本文介绍如何使用 GitHub 来进行 AMetal 的协同开"

冠蒋
5 years ago
Views:

1 Technical Note ( 指令版 ) TN V1.00 Date:2018/08/21 类别内容关键词 GitHub,AMetal 摘要本文介绍如何使用 GitHub 来进行 AMetal 的协同开发

2 修订历史版本日期原因 V /08/21 创建文档 i

3 目录 1. 适用范围 GitHub 准备工作安装 git for Windows 下载 git for Windows 安装 git for Windows 安装完成创建 GitHub 账号协同开发获取源码源码同步向上同步代码请求合并到源码库免责声明

4 1. 适用范围本文档适用于使用 Github 进行协同开发的操作,GitHub 用于开源项目, 周立功公司的 Ametal 代码也在上面开源, 通过 GitHub 可以获取到代码进行开发, 本文档就如何安装 GIT 插件, 如何获取源码, 如何创建创建账号, 如何将源码导入自己的仓库, 如何克隆到本地进行使用, 如何进行代码同步, 如何将修改的代码上传到仓库, 以及如何贡献自己的代码到原仓库中等本文使用 Github 指令进行操作, 如需要使用图形化 GitHub 操作, 请参考文档 GitHub 协同开发指南 ( 图形版 )V1.00.pdf 1

1 所示图 2.1 下载 git for Windows 2.1.2 安装 git for Windows 下载得到的是 exe 文件, 如图 2.2 所示, 双击启动安装 ( 全部默认设置即可 ) 图 2.

5 2. GitHub 准备工作在进行源码获取之前, 我们需要安装 Git for Windows 软件和创建一个自己的 GitHub 账号 2.1 安装 git for Windows 下载 git for Windows 访问该网址, 下载 git for Windows 工具, 如图 2.1 所示图 2.1 下载 git for Windows 安装 git for Windows 下载得到的是 exe 文件, 如图 2.2 所示, 双击启动安装 ( 全部默认设置即可 ) 图 2.2 安装 git for windows 安装完成安装完成后, 点击鼠标右键可以看到 Git bash here 和 Git GUI here 选项, 点击 Git bash here, 可进入 Git bash 命令窗口, 如图 2.3 所示图 2.3 安装完成 2

2.1.4 创建 GitHub 账号 1. 访问 GitHub 官网, 登录 https://github.com, 注册一个自己的账号填入自己的信息后, 点击注册如图 2.4 所示图 2.4 创建 github 账号 2.

6 2.1.4 创建 GitHub 账号 1. 访问 GitHub 官网, 登录注册一个自己的账号填入自己的信息后, 点击注册如图 2.4 所示图 2.4 创建 github 账号 2. 如图 2.5 所示, 点击 continue( 免费使用, 所建仓库为公共仓库, 所有人均可见 ) 图 2.5 点击 continue 3. 选择计划用 github 做什么, 信息收集表,( 直接跳过即可 ), 如图 2.6 所示 3

7 图 2.6 点击跳过 4. 激活邮箱, 注册邮箱会收到一封邮件, 点击其中的激活链接即可, 如图 2.7 所示到此准备工作完成图 2.7 激活邮箱 4

8 3. 协同开发 3.1 获取源码 1. 账号注册完成之后, 使用自己的账号登录到 GitHub 官网, 搜索 AMetal 仓库, 如图 3.1 所示图 3.1 搜索 Ametal 仓库 2. 在搜索结果中选择 zlgopen/ametal, 一般为搜索结果第一个既是, 如图 3.2, 也可在浏览器地址栏中直接输入 AMetal 开源地址 : 图 3.2 搜索 AMetal 3. 将 Ametal 仓库 fork 到自己的仓库, 如图 3.3 所示, fork 前, 可以点击 watch 和 star watch 后, 如果仓库有更新会邮件通知 5

4 所示, 自己账号下的仓库即有权限修改, 这个仓库的地址为 : https://github.

9 图 3.3 fork 操作 4. fork 完成后, 自己账号下也有一个 ametal 仓库了, 如图 3.4 所示, 自己账号下的仓库即有权限修改, 这个仓库的地址为 : 图 3.4 fork 完成 5. 将仓库克隆到本地以便使用, 查看 clone 地址, 如图 3.5 所示图 3.5 查看 clone 地址 6

10 6. 将仓库克隆到本地以便使用, 在本地建立一个目录, 将仓库克隆到该位置, 如图 3.6 所示图 3.6 建立克隆目录 7. 在该目录下, 右键, 然后点击 Git bash here, 运行 Git clone 命令, 如图 3.7 所示图 3.7 克隆源码到本地所示 8. clone 完成, 在本地目录下生成了一个 ametal 的目录, 即克隆的源码, 如图 3.8 7

11 图 3.8 克隆完成 3.2 源码同步 zlgopen/ametal 项目在不断维护, 可能会上传新的代码, 或者修复已有代码的一些问题本地使用的代码应该与 zlgopen/ametal 上的代码经常同步, 保持一致 1. 添加 zlgopen/ametal 的克隆地址为本地仓库的远端仓库, 如图所示, 右键点击进入 Git bash here, 输入 git remote add zlgopen, 然后拷贝自己的仓库地址, 回车, 如图所示 ( 这里 zlgopen 仅仅是是后面链接的代号, 也可以是其他, 如 zlgopencode 等, 方便记忆即可 ) 图 3.9 添加克隆地址为本地仓库的远端仓库 2. 查看当前的远程仓库, 前面已添加克隆地址作为本地仓库的远端仓库, 这里我们需要查看一下是否设置成功, 接着输入命令行 git remote -v, 回车即可查看,origin 为 clone 时的链接, 后面的 zlgopen 和 zlgopencode 为前面添加的远端仓库地址, 如图 3.10 所示 8

12 图 3.10 查看添加的地址 3. 将 zlgopen/ametal 上的更新拉取到本地, 输入命令 git pull zlgopen master, 回车, 之后会更新 zlgopen/ametal 到本地, 建议在每次开发之前, 可以执行一次该操作, 确保得到最新的代码, 如图 3.11 所示图 3.11 更新代码到本地 9

13 3.3 向上同步代码 1. 在本地修改自己的代码后, 自己的远程仓库 (yanjianxiong/ametal) 还未更新, 需要上传更新自己的代码到自己的远程仓库, 操作如图 3.12 所示输入指令 git push origin master. 回车, 会弹出 GitHub 的登录窗口图 3.12 输入上传指令 2. 首次上传, 需配置邮箱和用户名, 操作方法如图 3.13 所示图 3.13 配置邮箱和用户名 3. 例如添加一个 readme 文本文件,readme 文本的内容不得为空, 可向里面加一行代码, 如加一行 hello 到文本中, 如图 3.14 所示 10

14 图 3.14 添加文本测试 4. 使用 git add 命令将其添加到缓存中, 准备提交, 如图 3.15 所示图 3.15 添加内容到缓存 5. 使用 git commit 命令提交到本地仓库, 如图 3.16 所示, 建议每次提交时都添加日志记录, 明确修改了什么内容, 成为一种习惯建议设置登录的邮箱为自己电脑的本机邮箱, 因公司电脑无法登录外网, 绑定的邮箱也非公司邮箱, 所以出现下面的验证提示, 可忽略该提示 ; 如果使用电脑上的验证邮箱与 GitHub 邮箱一致, 则不会出现后面的提示 11

15 图 3.16 添加日志 6. 将修改上传到自己的 github 上的仓库中, 操作如图 3.17 所示输入命令 git push origin master, 回车即可图 3.17 上传到自己的 GitHub 库 7. 登录到仓库查看, 可看到已上传成功, 如图 3.18 所示 12

16 图 3.18 登录查看上传情况 3.4 请求合并到源码库开源项目永远期待更多的人加入, 为开源贡献自己的力量若修改没有问题, 可以请求将修改合并到 zlgopen/ametal 开源项目中 1. 登录到 github, 查看自己的修改内容, 如图 3.19 所示 ( 这里由于我修改时公司电脑绑定邮箱无法收到外部邮件, 故这里提示修改人为 unknown, 如用自己电脑, 可以看到修改人为自己的用户名 ) 图 3.19 查看自己的修改内容 13

17 2. 检查修改, 确认无误, 如图 3.20 所示图 3.20 检查修改 3. 创建新的 pull 请求, 如图 3.21 所示图 3.21 点击红框所示添加请求 4. 发起 pull 请求, 如图 3.22 所示 14

18 图 3.22 发起 pull 请求 5. 添加修改内容的描述主题等, 方便原库管理人员检查, 如图 3.23 所示图 3.23 添加申请原因 6. 在合并之前, 可以关闭请求, 如图 3.24 所示 15

19 图 3.24 关闭合并请求 16

20 4. 免责声明应用信息本应用信息适用于 AMetal 平台的开发设计客户在开发产品前, 必须根据其产品特性给予修改并验证修改文档的权利本手册所陈述的产品文本及相关软件版权均属所有, 其产权受国家法律绝对保护, 未经本公司授权, 其它公司单位代理商及个人不得非法使用和拷贝, 否则将受到国家法律的严厉制裁保留在任何时候修订本用户手册且不需通知的权利您若需要我公司产品及相关信息, 请及时与我们联系, 我们将热情接待 17

21 销售与服务网络地址 : 广州市天河区龙怡路 117 号银汇大厦 16 楼邮编 : 电话 : 网址 : 传真 : 深圳周立功地址 : 深圳市福田区深南中路 2072 号电子大厦 1203 室周立功厦门办地址 : 厦门市思明区厦禾路 855 号英才商厦 618 室电话 : 电话 :(0755) / 传真 :(0755) 华南汽车地址 : 深圳市坪山区比亚迪路大万文化广场 A 座 1705 电话 : / 传真 : 上海周立功地址 : 上海市黄浦区北京东路 668 号科技京城东座 12E 室电话 : / / 传真 : 周立功苏州办地址 : 江苏省苏州市广济南路 258 号 ( 百脑汇科技中心 1301 室 ) 电话 : & 周立功宁波办地址 : 浙江省宁波市高新区星海南路 16 号轿辰大厦 1003 电话 : / 南京周立功地址 : 南京市秦淮区汉中路 27 号友谊广场 17 层 F G 区电话 : / / 传真 : 杭州周立功地址 : 杭州市西湖区紫荆花路 2 号杭州联合大厦 A 座 4 单元 508 电话 : / / 传真 : 周立功合肥办地址 : 安徽省合肥市蜀山区黄山路 665 号汇峰大厦 1607 电话 : 北京周立功地址 : 北京市海淀区紫金数码园 3 号楼 ( 东华合创大厦 )8 层 0802 室电话 : / / 传真 : 周立功天津办地址 : 天津市河东区十一经路与津塘公路交口鼎泰大厦 1004 室电话 :

22 周立功山东办地址 : 山东省青岛市李沧区青山路 689 号宝龙公寓 3 号楼 311 电话 : 武汉周立功地址 : 武汉市武昌区武珞路 282 号思特大厦 807 室电话 : / / 传真 : 周立功西安办地址 : 西安市高新区科技二路 41 号高新水晶城 C 座 616 室电话 : & 周立功郑州办地址 : 河南郑州市中原区百花路与建设路东南角锦绣华庭 A 座 1502 室电话 : 周立功长沙办地址 : 湖南省长沙市岳麓区奥克斯广场国际公寓 A 栋 2309 房电话 : 周立功沈阳办地址 : 沈阳市浑南新区营盘西街 17 号万达广场 A4 座 2722 室电话 : 重庆周立功地址 : 重庆市渝北区龙溪街道新溉大道 18 号山顶国宾城 11 幢 4-14 电话 : / / 传真 : 成都周立功地址 : 成都市一环路南二段 1 号数码科技大厦 403 室电话 : / / 传真 : 香港周立功地址 : 香港新界沙田火炭禾香街 9-15 力坚工业大厦 13 层电话 :(852)

Technical Note GitHub 协同开发指南 ( 图形版 ) AMetal 平台协同开发 TN V1.00 Date:2018/08/21 工程技术笔记类别内容关键词 GitHub,AMetal 摘要本文介绍如何使用 GitHub 来进行 AMetal 的协同开

Technical Note GitHub 协同开发指南 ( 图形版 ) AMetal 平台协同开发 TN V1.00 Date:2018/08/21 工程技术笔记类别内容关键词 GitHub,AMetal 摘要本文介绍如何使用 GitHub 来进行 AMetal 的协同开 Technical Note ( 图形版 ) TN01010101 V1.00 Date:2018/08/21 类别内容关键词 GitHub,AMetal 摘要本文介绍如何使用 GitHub 来进行 AMetal 的协同开发修订历史版本日期原因 V1.00 2018/08/21 创建文档 i 目录 1. 适用范围... 1 2. GitHub 准备工作... 2 2.1 安装 git for

Technical Note GitHub 协同开发指南 ( 指令版 ) AMetal 平台协同开发 TN V1.00 Date:2018/08/21 工程技术笔记 类别 内容 关键词 GitHub,AMetal 摘 要 本文介绍如何使用 GitHub 来进行 AMetal 的协同开

Technical Note GitHub 协同开发指南 ( 指令版 ) AMetal 平台协同开发 TN V1.00 Date:2018/08/21 工程技术笔记类别内容关键词 GitHub,AMetal 摘要本文介绍如何使用 GitHub 来进行 AMetal 的协同开