ARTICLE DETAIL

资讯详情

深耕网站建设、视觉设计与SEO优化的一线实战洞察。

GitHub Desktop 完成首次开源贡献:first-contributions 项目 GUI 全流程实战指南

GitHub Desktop 完成首次开源贡献:first-contributions 项目 GUI 全流程实战指南 GitHub Desktop 完成首次开源贡献first-contributions 项目 GUI 全流程实战指南【免费下载链接】first-contributions✨ Help beginners to contribute to open source projects项目地址: https://gitcode.com/gh_mirrors/fi/first-contributions导读本指南以 first-contributions 仓库中面向初学者的 GitHub Desktop 教程希伯来语版英文原版见 github-desktop-tutorial.md为核心完整讲解使用 GitHub Desktop 图形客户端完成fork - clone - edit - PR标准贡献工作流。读完本文你将掌握如何 Fork 他人仓库、用 GitHub Desktop 克隆自己的 Fork、创建分支、修改文件、提交Commit、推送Publish/Push以及提交 Pull Request从而安全地完成人生第一次开源贡献且不会破坏任何现有代码。一、为什么选择 first-contributions 作为第一次贡献的起点首次做任何事都是困难的尤其是团队协作时犯错总让人不安。但开源本质上就是协作与一起工作。first-contributions 这个项目的设计初衷正是为了让新手在不会搞坏任何东西的前提下通过真实操作完成第一次贡献——阅读文章、观看视频固然有帮助但远不如亲自实践一遍来得深刻。本仓库整体布局清晰根目录的 README.md 是主入口集中了多种语言翻译和各类工具教程导航Contributors.md 是贡献者名单也是本教程中用于练习修改的目标文件docs/目录下则按类别存放着命令行教程docs/cli-tool-tutorials/、GUI 工具教程docs/gui-tool-tutorials/以及 Git 工作流场景的进阶资料docs/additional-material/git_workflow_scenarios/。在 README.md 的教程导航表格中第一项即是 GitHub Desktop 教程入口。本文对应的英文原版教程位于 docs/gui-tool-tutorials/github-desktop-tutorial.md。前置条件安装 GitHub Desktop如果电脑上尚未安装请前往 GitHub Desktop 官网下载并安装桌面客户端。版本要求本教程面向 GitHub Desktop1.0 及以上版本。如果你使用的是 1.0 之前的老版本界面与操作路径差异较大请参考仓库中的旧版 GitHub Desktop 教程旧版流程为打开应用 → 点击左上角→ 选择Clone→ 克隆first-contributions→ 选择本地目录而非新版教程中的浏览器端 Open in GitHub Desktop 方式。二、整体流程一览本教程的完整工作流可概括为一条主线fork在网页端 Fork 仓库 - clone用 GitHub Desktop 克隆到本地 - branch创建专属分支 - edit修改 Contributors.md - commit提交变更 - publish/push推送回 GitHub - PR提交 Pull Request 请求合并这条fork - clone - edit - PR流程是开源贡献中最常见、最高频的标准操作熟练掌握后可以复用到任何其他开源项目上。三、Step 1Fork 本仓库在 GitHub 网页端打开 first-contributions 仓库主页点击页面右上角的 Fork 按钮。这一步会在你自己的账号下生成该仓库的一份独立副本。为什么要 Fork因为普通用户没有直接向别人仓库写入代码的权限。Fork 相当于复制一份到我的名下之后你可以自由地在自己的副本上修改、推送再通过 Pull Request 请求原作者合并你的改动。四、Step 2用 GitHub Desktop 克隆仓库到本地克隆Clone是把远程仓库完整下载到本机的操作克隆后本地就有了一个可编辑的工作副本。⚠️ 重要提示千万不要克隆原始仓库first-contributions必须进入你自己 Fork 出来的仓库再对它执行克隆。具体操作步骤在你自己的 Fork 仓库页面点击绿色的Code按钮。在下拉菜单中选择Open in GitHub Desktop。系统会弹出系统级确认窗口点击Open GitHubDesktop.exe允许调用桌面客户端。GitHub Desktop 中会出现Clone a repository克隆仓库对话框确认路径无误后点击Clone。随后弹出How are you planning to use this fork?你打算如何使用这个 Fork对话框选择To contribute to the parent project向父项目贡献然后点击Continue。完成上述步骤后first-contributions 仓库的内容就已经完整复制到你的电脑上可以在本地自由编辑了。知识点克隆在 Git 层面等价于git clone它会同时下载完整的提交历史与当前工作区文件。GitHub Desktop 在克隆 Fork 时询问用途是为了帮你预设好与上游父项目的关联关系方便后续贡献与同步。五、Step 3创建专属分支Branch分支是 Git 并行开发的核心机制。在提交任何改动之前应该先创建一个独立分支避免直接污染默认分支main。操作步骤在 GitHub Desktop 顶部点击Current branch当前分支图标。在弹出的菜单中选择New branch新建分支。将分支命名为add-your-name的格式例如add-james-smith。点击Create branch完成创建。命名建议用add-前缀加用户名来命名分支既语义清晰表明这个分支用于添加你的名字又能避免与他人分支重名。六、Step 4修改文件并提交Commit6.1 编辑 Contributors.md切换到 GitHub Desktop 顶部的History历史标签页。在文件列表中右键点击Contributors.md选择Open in text editor在文本编辑器中打开。滚动到文件最底部追加你的名字然后保存文件。6.2 添加名字的格式Contributors.md 是一份纯文本的贡献者名单目前已有数千条记录截至本教程所在版本已有 5900 行。每一行的标准格式是名字 GitHub 主页链接。例如如果你的名字是 James Smith[James Smith](https://github.com/你的GitHub用户名)从仓库中 Contributors.md 的实际内容可以看到贡献者条目的真实形态例如- [Jess Hosfelt](https://github.com/JessH0516) My first open-source contribution! - [Stephen Hopfensperger](https://github.com/Stephen-Hopfensperger) Have a great day! - [Sachin Kumar](https://github.com/ST-SACHIN-KUM)格式要点使用 Markdown 链接语法名字名字与链接之间不要有空格可选在链接后追加一句留言如 My first open-source contribution!但保持简洁即可一定要追加在文件末尾而不是修改或删除已有的任何行避免制造不必要的冲突。6.3 确认变更状态保存文件后切回 GitHub Desktop可以看到Contributors.md的变更已被客户端自动识别并显示在变更列表中——GitHub Desktop 会自动检测工作区的文件改动相当于git status的可视化呈现。6.4 提交变更在 GitHub Desktop 左下方的Summary摘要输入框中填写提交信息Add your-name to Contributors list将your-name替换成你自己的名字注意此处的名字应与分支名中的一致。然后点击Commit to add-your-name按钮按钮名会随你的分支名变化格式为Commit to 你的分支名。点击后在窗口底部可以看到这条 commit 已经创建成功。每个 commit 都记录了作者、时间与改动内容GitHub Desktop 的提交操作对应 Git 底层的git commit只是将暂存stage与提交合并成了可视化的一键操作。七、Step 5推送Publish/Push变更到 GitHub本地提交完成后变更还只存在于你的电脑上需要推送到 GitHub 上的远程仓库点击菜单File → Options文件 → 选项。在账户设置中登录 GitHub.com输入你的 GitHub 用户名和密码推荐使用 Token 或个人访问令牌方式。回到主界面点击右上角的Publish发布按钮。Publish 会将本地分支连同提交推送到你 Fork 的远程仓库对应git push。推送成功后你的改动就同步到了 GitHub 上的 Fork 副本中。说明由于这是分支的首次推送GitHub Desktop 显示的是 Publish此后该分支再次推送时按钮会变为 Push。八、Step 6提交 Pull Request 请求合并推送完成后回到 GitHub 网页端进入你自己的 Fork 仓库页面顶部会出现一个醒目的Compare pull request比较并创建拉取请求按钮点击它。在打开的 Pull Request 创建页面中确认base分支是上游仓库first-contributions的默认分支compare分支是你的add-your-name分支。填写 PR 标题与说明可简单描述添加我的名字到贡献者列表。点击Create pull request / Submit提交。提交后你的 PR 会进入项目维护者的审查队列。合并成功后你会收到一封邮件通知并能在 Contributors.md 中看到自己的名字——此时你的第一次开源贡献就正式完成了九、从仓库源码看为什么这个流程绝对安全回到文档开头的那句话在不破坏任何东西的情况下真正动手实践。这个安全性由两个仓库层面的事实保证Fork 隔离你的所有改动都发生在自己账号下的副本中Fork与上游仓库完全隔离无论你怎么折腾都不会影响原仓库的任何一行代码。分支隔离在本地副本中改动又进一步隔离在独立分支add-your-name上默认分支main保持原样。即使 PR 被拒绝或操作失误也只需丢弃该分支即可恢复。审查把关PR 的合并权在维护者手中文档原话很快我会将你的所有变更合并进项目的主分支任何合并都会经过人工确认不存在一键破坏的可能。这正体现了 Git 工作流多重保险的设计哲学远端 Fork、本地分支、PR 审查三层隔离让新手可以放心大胆地实践。十、完成之后进阶资料与后续路径恭喜你已经完成了标准开源贡献流程。作为开源贡献者这套fork - clone - edit - PR流程你会反复遇到。接下来可以沿着仓库提供的路径继续深入10.1 进阶 Git 技巧推荐按需查阅本教程末尾指向的补充资料索引了完整的 Git 进阶场景全部位于 docs/additional-material/git_workflow_scenarios/ 目录下核心主题包括场景对应文档适用时机修改最近一次提交amending-a-commit.md提交信息写错了、漏提交了文件配置 Git 用户信息configuring-git.md更好地控制 Git 配置让 Fork 与上游保持同步keeping-your-fork-synced-with-this-repository.mdFork 落后于父仓库时把提交移动到其他分支moving-a-commit-to-a-different-branch.md提交放错了分支删除本地分支delete-branch-locally.mdPR 合并后清理分支解决合并冲突resolving-merge-conflicts.md多人改动同一文件时回退已推送的提交reverting-a-commit.md需要撤销已推送的提交压缩多个提交squashing-commits.md评审者要求合并提交信息撤销本地提交undoing-a-commit.md本地仓库改乱了想重置其中保持 Fork 与上游同步尤其值得关注随着你和许多人持续向项目贡献上游仓库会不断前进学会同步才能让你的 Fork 始终基于最新代码降低合并冲突的概率。10.2 其他工具的教程如果你对其他协作工具感兴趣可以在 README.md 的教程导航中找到使用 Visual Studio 2017、GitKraken、VS Code、Atlassian Sourcetree、Sublime Merge、GitHub CLI、命令行 Git 等不同工具的完整教程它们都遵循完全相同的fork - clone - edit - PR逻辑只是操作入口不同。10.3 多语言支持本仓库的教程与 README 均提供数十种语言的翻译版本例如本文对应的希伯来语版位于 docs/gui-tool-tutorials/translations/Hebrew/github-desktop-tutorial-heb.md中文版教程见 github-desktop-tutorial.zh-cn.md翻译索引见 docs/translations/Translations.md。这说明第一次贡献的学习资源覆盖了全球各个语言的开发者社区。十一、总结一次贡献终身受益回顾整个流程你实际完成的事包括Fork在云端复制了一份仓库到自己的账号Clone通过 GitHub Desktop 将 Fork 下载到本地Branch创建以add-开头的专属分支Edit在Contributors.md末尾按标准格式追加自己的名字Commit用Add your-name to Contributors list作为提交信息完成本地提交Publish登录 GitHub 账户后把分支推送到远程PR点击Compare pull request提交合并请求等待维护者审查合并。这套流程不只在 first-contributions 有效——它正是全球数百万开源项目通用的贡献范式。当你下一次向任何开源项目提交代码时走的依然是这条路。现在去提交你的第一次贡献吧【免费下载链接】first-contributions✨ Help beginners to contribute to open source projects项目地址: https://gitcode.com/gh_mirrors/fi/first-contributions创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表