Git 学习任务：嵌入式项目版本管理与团队协作

任务目标

为了帮助大家更好地掌握 Git 这一强大的工具，并顺利进行团队协作、版本管理，遵循规范的代码和 PCB 设计流程，促进团队技术水平的提升，同时让团队成员能够方便地查看、学习和借鉴彼此的设计成果，促进团队整体技术水平的提升与协作默契的养成。现布置以下学习任务完成以下任务：

1. 熟练掌握 Git 的基本操作。
2. 将校内赛工程上传到 GitHub，创建相关文档，进行规范的版本管理。

任务要求

1. GitHub 账号创建

首先，请前往 GitHub 官网并注册个人账号：GitHub 官网
ps：至于如何创建账号，这里就不赘述了，大家可以自行搜索。

2. 本地下载 Git

在你的计算机上下载并安装 Git： 具体的操作可以参考网上的教程，这里就不赘述了。

2. Fork 仓库并创建分支

请按照以下步骤操作：

(1) Fork 我们的远程仓库

• 进入实验室作业仓库，点击 "Fork" 将仓库复制到你的 GitHub 账号中。

(2) 在本地新建分支

• 在 fork 后的仓库中创建一个新的分支，分支名称使用你的 拼音名字（例如：张三 zhangsan）。

  git checkout -b zhangsan

（3）上传嵌软/嵌硬项目代码/相关文件

• 嵌软在本地新建的分支改为自己的 Keil 工程及其源码。
• 嵌硬在本地新建的分支改为自己的原理图、PCB 布线文件、BOM 表等必要的文件。
• 嵌软文件结构可以参考以下结构：

  分支名/
  ├── Keil 工程文件夹/
  │   ├── Core/
  │   ├── Drivers/
  │   ├── MDK-ARM/
  │   ├── ...
  |   |── ...
  ├── 图片等资源（小车的照片等）/
  ├── 其他文件（自己的学习日志等）/
  ├── .gitignore
  └── README.md
  

• 嵌硬文件结构可以参考以下结构：

  分支名/
  ├── 你的工程名.eprj
  ├── 图片等资源（小车的照片等）/
  ├── 其他文件（自己的学习日志等）/
  ├── README.md
  

• Markdown 说明文档编写 (嵌软嵌硬都要写)

  在项目的根目录下创建 README.md 文件，撰写详细的工程说明，包括以下内容：
  项目名称: 项目名称
  功能描述：简要描述工程的基本功能，以及用到了什么模块，什么外设，什么芯片，嵌软可以写代码框架，封装等。
  图片辅助说明：如有需要，上传相关截图并在文档中插入图片，图片文件需要放在项目中，并规范图片路径（可以是队伍获奖照片，小车照片什么的都可以）。

• .gitignore 文件编写 （只要求嵌软写）

  在工程根目录下创建 .gitignore 文件，编写规则以屏蔽无关文件。常见规则示例如下：

  /.gitignore
  # 忽略 Keil 工程编译生成的文件
  *.bak
  *.hex
  *.bin
  *.out
  # 忽略 VSCode 配置文件夹
  .vscode/
  

  ps：嵌软需要根据自己工程的文件夹结构来屏蔽不同的文件，具体操作可以上网搜索。

（4）推送到远程仓库 提交 Pull Request：

• 在分支内完成所有修改后，执行以下命令将修改推送到远程仓库：
  ps：注意是提交到源仓库的分支，而不是你的分支，提交到你自己的分支我们是看不到的也没办法审核的。

  git add .
  git commit -m "描述你的修改内容"
  git push origin zhangsan

  ps:在github里面提交的时候记得选中你自己的分支。

  提交 Pull Request 给我们源仓库的主分支，我们会进行审核，审核通过后你的分支就能被添加进来。