嵌入式开发之路

GitHub - 代码协作的全球派对🎉

Properties2
descriptionGitHub可不是普通的代码仓库！它是全球千万开发者的社交平台，是开源项目的聚集地，更是程序员的'简历加分神器'✨。 不管你是想给开源项目贡献代码，还是搭建自己的项目让别人帮忙，甚
tagsgit

21分钟阅读

GitHub可不是普通的代码仓库！它是全球千万开发者的社交平台，是开源项目的聚集地，更是程序员的”简历加分神器”✨。 不管你是想给开源项目贡献代码，还是搭建自己的项目让别人帮忙，甚至是找工作时展示作品集——GitHub都能搞定！这一章我们从入门到进阶，用最有趣的例子+实操代码，让你快速玩转GitHub～

第一部分：账户设置与配置

👤 账户设置与配置 - 打造你的专属开发者身份

账户注册

SSH密钥配置

双因素认证

个人资料完善

1. 账户注册 - 免费入场券🎫

注册GitHub账户超简单，3步就能搞定：

  1. 访问官网 https://github.com，输入用户名、邮箱和密码
  2. 密码要求：至少1个小写字母+1个数字+7个字符（安全第一！）
  3. 验证邮箱（重要！后续协作、找回密码都要用）

免费账户可以创建无限个公开仓库，适合开源项目和学习使用。如果需要私有仓库，可以升级付费计划～

2. SSH密钥配置 - 免密码登录神器🔑

默认用HTTPS链接仓库，每次推送都要输用户名密码，太麻烦了！配置SSH密钥后，就能免密登录，效率翻倍～

1. 检查本地是否已有SSH密钥（Windows用Git Bash，Mac/Linux用终端） ls -al ~/.ssh # 查看.ssh目录下的文件# 2. 如果没有，生成新密钥（替换成你的GitHub邮箱） ssh-keygen -t ed25519 -C “你的邮箱@example.com” # 按3次回车（不需要设置密码，直接默认即可） # 3. 启动SSH代理，添加密钥 eval ”$(ssh-agent -s)” # 启动代理 ssh-add ~/.ssh/id_ed25519 # 添加私钥 # 4. 复制公钥内容（Windows可能需要用cat命令查看后复制） cat ~/.ssh/id_ed25519.pub # 复制输出的全部内容（从ssh-ed25519开始到邮箱结束）

接下来在GitHub上添加公钥：

  1. 点击右上角头像 → Settings（设置）
  2. 左侧选择 SSH and GPG keys → New SSH key
  3. 标题填”我的笔记本”（方便区分多设备），粘贴公钥内容，点击 Add SSH key

💡 测试是否配置成功：终端输入

ssh -T git@github.com

，出现 “Hi 你的用户名! You’ve successfully authenticated…” 就说明搞定啦～

3. 双因素认证（2FA）- 账户安全双保险🛡️

只靠密码不够安全！开启双因素认证后，登录需要”密码+动态验证码”，就算密码泄露也不怕～ 配置步骤：

  1. Settings → Security（安全）→ Two-factor authentication（双因素认证）
  2. 选择验证方式：手机App（推荐Google Authenticator）或短信
  3. 按照提示扫描二维码，保存恢复码（重要！丢了手机能用来找回）
  4. 输入App生成的验证码，完成开启

⚠️ 警告：恢复码一定要保存好！可以写在纸上或存在安全的云盘里，丢了就麻烦啦～

4. 个人资料完善 - 让别人认识你🤳

完善个人资料，不仅能让协作更顺畅，还能给潜在雇主留下好印象：

  • 头像：上传清晰的照片或个性图标（Gravatar用户会自动同步）
  • 邮箱：添加所有你用于Git提交的邮箱（GitHub靠邮箱关联提交记录）
  • 个人简介：简单介绍自己，比如”前端开发爱好者｜开源贡献者”
  • 链接：添加个人博客、作品集网站等

比如你用A邮箱提交代码，却没添加到GitHub，别人就看不到是你提交的——所以一定要把所有常用邮箱都加上！

第二部分：给项目贡献代码

🤝 给项目贡献代码 - 从”旁观者”到”参与者”

Fork仓库

GitHub Flow

Pull Request（PR）

PR迭代

1. Fork仓库 - 复制一份自己的”玩具”🪀

如果想给别人的项目改代码，但没有直接推送权限怎么办？用Fork功能！

核心逻辑

：Fork就是在你自己的GitHub账户下，创建原项目的完整副本。你可以随意修改这个副本，不会影响原项目。 操作步骤：打开原项目页面（比如

https://github.com/schacon/blink

），点击右上角的”Fork”按钮，等待几秒就完成啦～

💡 小知识：Fork在GitHub里是中性词，不是”分叉造反”，而是合法的贡献方式～ 原项目作者还会感谢你的贡献呢！

2. GitHub Flow - 贡献代码的标准流程🚀

GitHub官方推荐的协作流程，简单6步，不管是小团队还是开源项目都适用：

步骤1：克隆自己Fork的仓库到本地（替换成你的用户名） git clone git@github.com:你的用户名/blink.git cd blink# 步骤2：从master分支创建主题分支（比如要做”减慢闪烁速度”功能） git checkout -b slow-blink # 分支名要清晰，让人一看就知道做什么 # 步骤3：修改代码，提交修改 # 比如把延迟1秒改成3秒（用编辑器改blink.ino文件，或用命令行） sed -i ” ‘s/1000/3000/’ blink.ino # Mac/Linux命令（替换文本） # Windows用：sed -i ‘s/1000/3000/’ blink.ino # 查看修改是否正确 git diff # 提交修改 git commit -am “将LED闪烁延迟从1秒改为3秒，体验更好” # 步骤4：推送到自己的GitHub仓库 git push origin slow-blink # 步骤5：在GitHub网页上打开PR（后续网页操作） # 步骤6：根据审核意见迭代修改，最后等待合并

3. 打开Pull Request（PR）- 向原项目”交作业”📝

推送分支后，就可以向原项目提交PR，请求作者合并你的修改：

  1. 打开你Fork的仓库页面，会看到”Compare & pull request”绿色按钮
  2. 填写PR标题和描述：标题要简洁（比如”优化LED闪烁延迟”），描述要说明修改原因和内容（比如”原1秒太快，3秒更易观察”）
  3. 选择目标分支（一般是原项目的master/main分支），点击”Create pull request”

PR就像一份”修改申请单”，原项目作者会看到你的代码修改，还能在线评论、提出修改意见～

4. PR迭代 - 根据意见修改代码🔄

提交PR后不一定一次通过，作者可能会让你调整代码。这时候不用重新开PR，直接在原来的分支上修改推送就行：

比如作者说”让灯灭的时间4秒，亮的时间3秒” # 再次修改blink.ino文件 vim blink.ino # 编辑文件，调整延迟时间 git commit -am “调整灭灯时间为4秒，优化闪烁效果” # 推送到同一个分支，PR会自动更新 git push origin slow-blink

推送后，PR页面会自动显示新的修改，作者能看到你的更新。沟通清楚后，作者就会点击”Merge pull request”合并你的代码——恭喜你，成为开源贡献者啦！🎉

5. 复杂场景：PR冲突了怎么办？😵

如果原项目在你Fork后更新了，你的PR可能会出现冲突（比如别人也改了同一个文件）。这时候需要同步原项目的最新代码：

1. 添加原项目为上游仓库（取名upstream） git remote add upstream https://github.com/schacon/blink.git# 2. 拉取原项目的最新代码 git fetch upstream # 3. 合并到你的功能分支 git merge upstream/master # 4. 如果出现冲突，打开冲突文件编辑 # 冲突文件里会有 <<<<<<< HEAD（你的代码） 和 >>>>>>> upstream/master（原项目代码）标记 # 编辑文件，保留正确代码，删除冲突标记 vim blink.ino # 5. 提交合并结果，重新推送 git add blink.ino git commit -m “合并上游仓库代码，解决冲突” git push origin slow-blink

这样PR就会显示”可以自动合并”，作者就能顺利合并你的代码啦～

第三部分：维护自己的项目

👑 维护自己的项目 - 做个靠谱的仓库管理员

创建仓库

添加协作者

管理PR

特殊文件

1. 创建仓库 - 搭建你的代码基地🏗️

想分享自己的项目？创建仓库超简单：

  1. GitHub首页点击”+” → New repository
  2. 填写仓库名称（简短好记，比如”my-first-project”）
  3. 可选：添加描述、初始化README文件、选择.gitignore模板（忽略不需要提交的文件）
  4. 点击”Create repository”，仓库就创建好啦！

创建后，GitHub会显示推送本地代码的命令，直接复制执行就行：

如果你本地已有项目代码 cd 你的项目目录 git init git add . git commit -m “初始化项目” git branch -M main git remote add origin git@github.com:你的用户名/仓库名.git git push -u origin main

2. 添加协作者 - 邀请小伙伴一起玩🤼

如果想让别人一起开发你的项目，需要添加协作者（给他们推送权限）：

  1. 仓库页面 → Settings → Collaborators（协作者）
  2. 输入对方的GitHub用户名或邮箱，点击”Add collaborator”
  3. 对方接受邀请后，就能克隆仓库、创建分支、推送代码啦～

⚠️ 注意：协作者有完全的推送权限，要只添加信任的人！如果是开源项目，建议用Fork+PR的方式，不用添加协作者～

3. 管理PR - 审核别人的贡献📋

当别人给你的项目提交PR时，你需要审核代码、沟通修改、最后合并：

  • 查看修改：PR页面会显示代码差异（新增用+，删除用-），可以逐行查看
  • 评论代码：点击差异行的”+“号，就能添加评论（比如”这里可以优化一下”）
  • 合并PR：如果代码没问题，点击”Merge pull request”合并；如果不想合并，点击”Close pull request”关闭

合并PR有两种方式：

  • 网页合并：直接点击按钮，GitHub会自动创建合并提交
  • 本地合并：适合复杂情况，拉取对方的PR分支本地测试后合并

本地合并PR的示例（假设PR编号是1） # 拉取PR分支（需要先配置拉取PR的规则） git fetch origin refs/pull/1/head:pr-1 # 切换到PR分支测试 git checkout pr-1 ./run-tests.sh # 运行测试脚本，验证代码是否正常 # 测试通过，合并到main分支 git checkout main git merge pr-1 git push origin main

4. 特殊文件 - 让项目更专业📄

添加这两个文件，能让你的项目更规范，方便别人贡献：

（1）README.md - 项目说明书

每个项目都应该有README，告诉别人这个项目是什么、怎么用：

  • 项目介绍：一句话说明项目用途（比如”一个简单的LED闪烁程序”）
  • 安装步骤：如何克隆、配置、运行项目
  • 使用示例：简单的代码或命令示例
  • 贡献指南：告诉别人如何给你提交PR
  • 许可证：项目的开源许可证（比如MIT）

（2）CONTRIBUTING.md - 贡献指南

如果你的项目比较复杂，可以添加这个文件，说明贡献规则：

  • 提交规范：比如”提交信息要包含功能+修改内容”
  • PR要求：比如”PR要关联Issue，运行测试通过”
  • 代码风格：比如”遵循PEP8规范（Python项目）”

有了这个文件，别人提交PR时，GitHub会自动提示他们先阅读贡献指南，减少不规范的PR～

第四部分：GitHub高级技巧

🧠 GitHub高级技巧 - 效率翻倍的秘密武器

Markdown语法

引用功能

通知管理

组织管理

1. GitHub Flavored Markdown - 让文字更漂亮✨

在Issue、PR描述、README里，都可以用GitHub专属的Markdown语法，让内容更易读：

（1）任务列表 - 跟踪进度

任务列表示例 - [x] 实现核心功能 - [ ] 编写测试用例 - [ ] 完善文档

渲染后会显示勾选框，点击就能标记完成，适合在PR里跟踪要做的事～

（2）代码片段 - 展示代码

用三个反引号包裹代码，还能指定语言实现语法高亮：

python # Python代码示例 def hello(): print("Hello GitHub!") hello()

（3）表情符号 - 增加趣味😆

输入

:表情名:

就能插入表情，比如

:+1:

是👍，

:bug:

是🐛。 推荐工具：

Emoji cheat sheet

，可以查询所有可用表情～

（4）图片上传 - 直观展示

在评论或README里，直接拖拽图片就能上传，GitHub会自动生成图片链接： 语法：

![图片描述](图片链接)

（拖拽后会自动生成）

2. 引用功能 - 快速关联内容🔗

在GitHub里可以快速引用Issue、PR、提交记录，方便追踪：

  • 引用Issue/PR：输入#编号（比如#5，会自动链接到编号5的Issue/PR）
  • 引用其他仓库的内容：输入用户名/仓库名#编号（比如schacon/blink#3）
  • 引用提交记录：粘贴完整的提交SHA-1（比如a5a7751a33b7e86c5e9bb07b26001bb17d775d1a）

示例：在PR描述里写”修复了#2的问题”，就能直接关联到编号2的Issue～

3. 通知管理 - 不被消息淹没📱

项目活跃后会收到很多通知（比如别人评论你的PR、提交新Issue），可以这样管理：

  • 开启/关闭通知：仓库页面点击”Watch”，可以选择”Watch”（接收所有通知）、“Unwatch”（不接收）、“Custom”（自定义）
  • 通知方式：Settings → Notifications，可以选择通过邮件或网页通知
  • 静音通知：在Issue/PR页面点击”Unsubscribe”，可以停止接收该内容的通知

4. 组织管理 - 团队协作利器🏢

如果是团队开发，可以创建GitHub组织（Organization），统一管理项目和成员：

  1. 创建组织：点击”+” → New organization，填写组织名称和邮箱
  2. 创建团队：组织页面 → Teams → New team，比如创建”前端团队”、“后端团队”
  3. 添加成员：给团队添加成员，设置权限（只读、读写、管理员）
  4. 管理项目：把项目移到组织下，团队成员就能按权限访问项目

比如公司可以创建”xxx公司”组织，所有项目都放在组织下，方便统一管理和协作～

第五部分：实战场景扩展

🌍 实战场景扩展 - 应对复杂协作情况

场景1：多人协作同一个功能

如果和同事一起开发一个功能，可以创建共享分支，实时同步进度：

1. 你创建共享分支并推送 git checkout -b feature-shared git push origin feature-shared# 2. 同事拉取共享分支 git fetch origin git checkout feature-shared # 3. 同事修改后推送 git commit -am “完成功能模块A” git push origin feature-shared # 4. 你拉取同事的修改，继续开发 git pull origin feature-shared # 开发功能模块B git commit -am “完成功能模块B” git push origin feature-shared

建议每天开发前先pull同步，避免冲突堆积～

场景2：误提交到错误分支

比如想提交到feature分支，却不小心提交到了main，可以用cherry-pick转移提交：

1. 查看main分支的提交ID（假设错误提交ID是abc123） git log main# 2. 切换到正确的feature分支 git checkout feature-正确分支 # 3. 转移错误提交 git cherry-pick abc123 # 4. 删除main分支的错误提交（如果还没推送） git checkout main git reset —hard HEAD~1 # 撤销最后一次提交 # 如果已经推送，用revert创建反向提交（不修改历史） git revert abc123 git push origin main

场景3：给旧项目提交补丁

有些老项目不支持PR，只接受补丁文件，可以用git format-patch生成补丁：

1. 创建补丁分支 git checkout -b patch-fix origin/master# 2. 修复问题并提交 git commit -am “修复XX bug” # 3. 生成补丁文件 git format-patch -M origin/master # 生成0001-xxx.patch文件 # 4. 发送补丁（通过邮件或其他方式） # 对方收到后，应用补丁：git am 0001-xxx.patch

总结与交付物提议

🎯 本章总结 - GitHub核心要点

  • 账户配置：注册后一定要配置SSH密钥和双因素认证，安全又方便
  • 贡献代码：Fork → 创建主题分支 → 修改 → 推送 → 开PR，遵循GitHub Flow
  • 维护项目：添加README和CONTRIBUTING文件，规范PR审核流程
  • 高级技巧：用好Markdown、引用功能、组织管理，提升协作效率

要不要我帮你整理一份GitHub入门速查手册？包含常用命令、PR提交模板、Markdown语法 cheat sheet，打印出来就能随时查阅～

关系图谱