杰瑞科技汇

GitHub客户端怎么用?新手入门指南。

GitHub 客户端终极教程:从入门到精通

本教程将分为以下几个部分:

GitHub客户端怎么用?新手入门指南。-图1
(图片来源网络,侵删)
  1. 为什么要使用 GitHub 客户端?
  2. 准备工作:安装与账户配置
  3. 核心概念:你必须知道的几个名词
  4. 新手入门:第一次克隆和提交代码
  5. 进阶操作:分支、合并与 Pull Request
  6. 团队协作:Fork 与代码审查
  7. 高级技巧与最佳实践
  8. 常见问题与故障排除
  9. 总结与资源推荐

为什么要使用 GitHub 客户端?

GitHub 官方客户端(原名 GitHub Desktop)是一个图形化工具,它让你无需记忆复杂的命令行指令,就能轻松完成 Git 和 GitHub 的核心操作。

主要优点:

  • 直观易用: 通过点击按钮和拖拽文件,即可完成代码的提交、推送、拉取和合并。
  • 可视化历史: 清晰地展示项目的提交历史,让你能直观地看到每一次变更。
  • 简化工作流: 自动处理配置文件(如 .gitconfig),让你专注于代码本身。
  • 无缝集成: 与 GitHub 仓库紧密集成,一键创建新仓库、Fork 他人仓库、发起 Pull Request。
  • 跨平台支持: 支持 Windows 和 macOS。

适合人群:

  • Git 和 GitHub 的新手。
  • 喜欢图形化界面的开发者。
  • 需要频繁进行分支和合并操作的开发者。
  • 参与开源项目,需要频繁处理 Pull Request 的贡献者。

准备工作:安装与账户配置

1 安装 GitHub 客户端

  1. 下载: 访问 GitHub Desktop 官方下载页面
  2. 选择系统: 根据你的操作系统(Windows 或 macOS)下载对应的安装包。
  3. 安装: 按照安装向导完成安装,这个过程通常很简单,只需“下一步”即可。

2 登录 GitHub 账户

  1. 启动客户端: 打开安装好的 GitHub Desktop。
  2. 登录:
    • 在欢迎界面,点击 "Sign in to GitHub"。
    • 你可以选择通过浏览器登录(推荐,更安全)或直接输入用户名和密码。
    • 如果开启了双重认证(2FA),系统会提示你输入验证码。
  3. 配置 SSH 密钥(可选但推荐):
    • 为了安全地与 GitHub 通信,客户端会自动帮你配置 SSH 密钥,你只需要在登录后,它会提示你“认证 SSH 密钥”,通常选择“Use an existing key”或“Create a new key”即可。
    • 你可以在客户端的 Settings > SSH Keys 中管理你的密钥。

核心概念:你必须知道的几个名词

在使用客户端之前,理解这几个基本概念会让你事半功倍。

GitHub客户端怎么用?新手入门指南。-图2
(图片来源网络,侵删)
  • 仓库: 一个项目,包含所有文件、历史记录和分支,你可以把它想象成一个项目的“文件夹”。
  • 克隆: 将 GitHub 上的仓库完整地下载到你的本地电脑上,这是你开始工作的第一步。
  • 提交: 将你本地修改的代码“保存”成一个版本,每次提交都有一个唯一的 ID 和描述信息。
  • 推送: 将你本地的提交上传到 GitHub 仓库,让其他人也能看到。
  • 拉取: 从 GitHub 仓库获取最新的代码,并合并到你的本地项目中,这可以确保你的本地代码与远程仓库保持同步。
  • 分支: 项目的独立副本,你可以在分支上开发新功能或修复 bug,而不会影响主代码,完成后再合并回主分支。
  • 合并: 将一个分支的修改整合到另一个分支中。
  • Pull Request (PR): 当你完成了一个分支的开发,可以发起一个 Pull Request,请求将你的代码合并到主分支,这是团队协作和代码审查的核心机制。

新手入门:第一次克隆和提交代码

让我们通过一个完整的流程,来体验一次标准的“克隆-修改-提交-推送”操作。

1 克隆一个仓库

  1. 找到仓库地址: 在 GitHub 网站上,找到你想要克隆的仓库(一个你自己的公开仓库)。
  2. 复制地址: 点击仓库页面右上角的绿色 "Code" 按钮,然后复制 SSHHTTPS 地址。
  3. 在客户端中克隆:
    • 打开 GitHub Desktop,点击左上角的 "File" -> "Clone Repository"
    • 在弹出的窗口中,点击 "URL" 选项卡。
    • 将你刚才复制的仓库地址粘贴到 "Repository URL" 输入框中。
    • 选择一个本地路径来存放这个仓库。
    • 点击 "Clone",等待片刻,仓库就会被克隆到你的电脑上。

2 修改并提交代码

  1. 打开项目: 克隆完成后,GitHub Desktop 会自动打开这个仓库,你也可以在左侧的 "Current Repository" 列表中选择它。
  2. 修改文件: 用你喜欢的代码编辑器(如 VS Code)打开仓库文件夹,修改任意一个文件,README.md,添加一些文字。
  3. 返回客户端查看变更: 切换回 GitHub Desktop,在 "Changes" 标签页下,你会看到被修改的文件。
  4. 暂存文件: 在文件名前面的复选框中打勾,表示你准备将这些修改纳入下一次提交。
  5. 撰写提交信息: 在下方的摘要框中,输入清晰的提交信息,"Update README with installation instructions",如果需要,可以在详情框中写更详细的说明。
  6. 提交到本地: 点击 "Commit to main" 按钮(如果你的默认分支是 main),修改只保存在你的电脑上,还没有上传到 GitHub。

3 推送到 GitHub

  1. 查看历史: 切换到 "History" 标签页,你会看到刚才的提交记录。
  2. 推送: 点击右上角的 "Push origin" 按钮。
  3. 完成! 你的代码已经成功上传到 GitHub 上了,刷新网页上的仓库,你会发现 README.md 文件已经被更新。

进阶操作:分支、合并与 Pull Request

这是现代软件开发的核心工作流。

1 创建一个新分支

假设你要开发一个新功能 "add-login-page"。

  1. 切换分支: 在客户端左下角,点击当前分支名(如 main)。
  2. 新建分支: 在弹出的菜单中,点击 "New branch"
  3. 命名分支: 输入新分支的名称,feature/add-login-page,确保 "Create a new branch from" 选择了 main
  4. 切换分支: 点击切换到这个新分支,所有的提交都会发生在这个分支上,而不会影响 main 分支。

2 在分支上开发并推送

重复 第4节 的操作:

  • 在新分支上修改代码。
  • 提交你的更改。
  • 推送你的更改,你会看到推送按钮变成了 "Push origin",点击它。

3 发起 Pull Request

你的新功能代码在 feature/add-login-page 分支上,而 main 分支还是旧的,你需要将它们合并。

  1. 切换回主分支: 在左下角切换回 main 分支。
  2. 发起 Pull Request:
    • 点击顶部菜单栏的 "Repository" -> "Open a Pull Request"
    • 客户端会自动比较 main 分支和你的 feature/add-login-page 分支的差异。
    • 你也可以在 GitHub 网站的仓库页面上,点击 "New pull request",它会自动检测到你的分支。
  3. 填写 PR 信息:
    • Title: 简明扼要地描述你的修改,如 "Add login page UI"。
    • Body: 详细描述你的改动、解决的问题以及任何其他相关信息,这对于代码审查者非常重要。
  4. 创建 PR: 点击 "Create pull request"

4 合并 Pull Request

  • 如果你是仓库所有者: 在 PR 页面,审查代码后,点击 "Merge pull request",然后选择合并方式(通常是 Create a merge commit),最后点击 "Confirm merge"
  • 如果你是贡献者: 你只需要等待仓库维护者审核和合并即可,合并成功后,你可以删除你的本地分支和远程分支。

团队协作:Fork 与代码审查

参与开源项目时,你通常需要先 Fork。

1 Fork 一个仓库

  1. 在 GitHub 网站的仓库页面,点击右上角的 "Fork" 按钮。
  2. 这会在你的 GitHub 账户下创建一个该仓库的完整副本。
  3. 克隆你 Fork 后的仓库: 按照第4.1节的方法,将你账户下的这个新仓库克隆到本地。

2 同步上游仓库

当你 Fork 的原始仓库有更新时,你需要同步你的 Fork。

  1. 在客户端中添加上游仓库:
    • 点击 Settings 图标(齿轮状)。
    • 在左侧菜单选择 "Repositories"
    • 找到你的仓库,点击右侧的 "Configure"
    • "Repository" 选项卡下,点击 "Add remote"
    • 将原始仓库(上游仓库)的 URL 添加进来,并命名为 upstream
  2. 拉取上游更新:
    • 在客户端的命令行工具中(Repository -> Command Palette),或者直接在本地使用命令行,执行 git pull upstream main 来获取上游的最新代码。
    • 然后推送到你的 Fork 仓库:git push origin main

高级技巧与最佳实践

  • 使用 Issues 跟踪任务: 在 GitHub 网站的仓库页面使用 Issues 来记录 Bug、新功能请求等,可以在提交信息中关联 Issue(Fixes #123)。
  • 使用 Projects 管理工作流: Projects 可以将 Issues 和 Pull Request 组织成看板,方便项目管理。
  • 保护分支: 在仓库的 Settings > Branches 中,可以设置分支保护规则,
    • 要求 PR 必须经过代码审查才能合并。
    • 要求 CI 检查必须通过。
    • 禁止直接推送,只能通过 PR 合并。
  • 使用模板: 为 Issues 和 Pull Request 创建模板,引导贡献者提供更规范的信息。

常见问题与故障排除

  • 问题: 提交按钮是灰色的,无法点击。

    • 原因: 你没有暂存任何文件。
    • 解决: 在 "Changes" 页面,点击文件名左侧的复选框来暂存文件。
  • 问题: 推送时提示 "You are not allowed to push to this branch"。

    • 原因: 该分支是受保护的,或者你没有推送权限。
    • 解决: 通过 Pull Request 的方式来合并你的代码。
  • 问题: 本地代码和远程代码有冲突。

    • 原因: 你在本地修改的同时,别人也推送了新的代码。
    • 解决:
      1. 先切换到主分支。
      2. 拉取远程最新代码 (git pull origin main)。
      3. 切换回你的分支。
      4. 将主分支的合并到你的分支 (git merge main),这时可能会出现冲突,需要手动解决冲突文件,然后再次提交和推送。
      5. 或者,更简单的方式是直接删除你的分支,从最新的 main 重新创建一个分支。

总结与资源推荐

GitHub 客户端是连接你和 GitHub 的强大桥梁,它将复杂的 Git 操作可视化,极大地降低了学习成本,提升了开发效率,掌握它,意味着你已经迈出了高效协作开发的第一步。

资源推荐:

希望这份详细的教程能帮助你顺利使用 GitHub 客户端!祝你编码愉快!

分享:
扫描分享到社交APP
上一篇
下一篇