embedded-framework/doc/git_usage.md
2024-02-27 22:08:38 -08:00

43 lines
4.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 1. **关于使用git爬取、上传文件以及创建本地分支的方法总结**
## 1.1. 背景
为了使一个有多人的开发团队协作的项目拥有统一的规范管理不至于杂乱无章一个可用、好用的代码管理工具的引入是必要的。目前为止笔者所接触到较多的两大代码管理工具分别是gitee和github本篇规范着重介绍gitee。与任何工具一样相使用好gitee就必然需要按照相对应的方法和步骤。本规范用于介绍在gitee上进行文件获取、上传以及本地分支的创建和提交的方法以及以上步骤遇到问题时的解决方法。
## 1.2. 操作方法/步骤及其解析
* 爬取文件git clone (所爬取的地址)
例如git clone https://gitee.com/xxxxxx/git-test.git
tips:当该指令的使用者在某个终端首次使用该指令时,会需要输入处于该仓库中的用户的账号密码,才允许对仓库中的内容进行获取,其表现如下:
~~~
xxxxx@ubuntu:~/2$ git clone https://gitee.com/xxxxxx/git-test.git
正克隆到 'git-test'...
Username for 'https://gitee.com': xxxxxx
Password for 'https://xxxxx@gitee.com':
remote: Enumerating objects: 13, done.
remote: Counting objects: 100% (13/13), done.
remote: Compressing objects: 100% (10/10), done.
remote: Total 13 (delta 0), reused 0 (delta 0), pack-reused 0
展开对象中: 100% (13/13), 4.31 KiB | 1.08 MiB/s, 完成.
~~~
* 提交文件:
核心步骤:
> cd xxx(所需提交的文件的目录)
> git add xxx(将需要提交的内容传至缓存区xxx所需提交的文件的名字)
> git commit -m "xxxxxx"(本次提交内容的行为的备注信息,在一切上传行为中,该步骤都不可省略)
> git pull origin master(将服务器中的最新内容下拉与本地的内容进行比较此处的master可以替换为读者希望下拉到的分支而非固定的master请注意直至下一步之前该步骤是上传前最后的纠错机会请务必确保无误后再操作下一步)
> git push origin master(将缓存区的内容上传至服务器此处的master可以替换为读者希望上传到的分支而非固定的master)
**tips:以上内容仅为上传文件的核心步骤,一般而言,为了规范化流程以减少出现错误的概率,笔者更建议在核心步骤前或后添加以下步骤:**
> git status .(此步骤用以检查区分本地的代码与gitee服务器中的代码的差别即与服务器中的相比读者新增加了哪些操作)
> xxx(核心步骤)xxx
> git log(该步骤可以将操作者所进行过的步骤以log的形式列出来以便操作者找到关键的信息,该步骤建议无论读者完成任何大型操作之后都进行一次,以便检查自己的操作有无失误)
* 创建并提交本地分支
> git branch -a(显示所有的主、分支并指明操作者所在的分支)
> git checkout -b xxxxx origin/master(切换到一个指定名字的分支中如果该分支不存在则在主支之外创建名字为“xxxxx”的本地分支并切换到该分支)
> git branch -a(显示所有的主、分支并指明操作者所在的分支,本次操作是处于谨慎考虑,再次检查自己所在的分支,以免操作失误)
> git add xxx.txt(将需要提交的内容传至缓存区xxx所需提交的文件的名字该步骤只是一个泛指指代一切希望上传到新创建的分区中的内容其在实际场景中极不可能只有一步由于git不允许将没有内容的分支上传到服务器所以该步骤不可省略)
> git commit -m "fenzhi test.("本次提交内容的行为的备注信息,在一切上传行为中,该步骤都不可省略)
> git pull origin KAIFA(将服务器中的最新内容下拉与本地的内容进行比较此处的KAIFA可以替换为读者希望下拉到的分支请注意直至下一步之前该步骤是上传前最后的纠错机会请务必确保无误后再操作下一步)
> git push origin xxxxxx:KAIFA(将缓存区的内容上传至服务器此处的KAIFA可以替换为读者希望上传到的分支xxxxx为操作者新创建的本地分区)
> git log(该步骤可以将操作者所进行过的步骤以log的形式列出来以便操作者找到关键的信息,该步骤建议无论读者完成任何大型操作之后都进行一次,以便检查自己的操作有无失误)