使用 Sublime Merge 完成第一次开源贡献first-contributions 实战指南【免费下载链接】first-contributions✨ Help beginners to contribute to open source projects项目地址: https://gitcode.com/gh_mirrors/fi/first-contributions本指南以 first-contributions 开源仓库为核心实践场面向希望借助图形化 Git 客户端完成首个 Pull RequestPR的新手开发者完整演示基于 Sublime Merge 的 fork → clone → 修改 → 提交 → push → PR 标准协作流程。阅读并实操本文后你将掌握 Sublime Merge 中克隆仓库、创建分支、暂存stage、提交、推送与发起 PR 的完整操作理解分支与暂存区在多人协作中的实际作用为日后参与任何开源项目打下基础。为什么选择 first-contributions 作为第一次贡献的起点第一次做某件事总是最难的尤其是当你正在与他人协作、尝试全新工具时犯错往往令人不安。但开源的本质就是协作与共同工作first-contributions 项目正是为了简化新手第一次参与开源的路径而存在见 README.md项目描述为 Help beginners to contribute to open source projects其核心理念是与其只读教程、看视频不如在不会弄坏任何东西的前提下真正动手做一遍。整个仓库的骨架就是 Contributors.md当前已收录数千名贡献者名单每一位参与者的任务只有一个——把自己的名字加进这份名单从而跑通完整的开源贡献流程。阅读文章和观看视频教程固然有帮助但没有什么比实际动手做一次更有价值。这个仓库刻意把贡献动作简化到往名单里加一个名字的最小难度让新人可以零压力地熟悉 GitHub 的 fork、clone、branch、commit、push、PR 全套流程。按照下面的步骤走完你会发现第一次贡献远比想象中简单而且充满乐趣。Sublime Merge 简介与安装Sublime Merge 是一款基于原生界面构建的 Git 图形化客户端下载、安装并打开它即可开始。它是本项目 GUI 工具教程矩阵中的一员仓库中与它并列的还有 GitHub Desktop 教程、Visual Studio Code 教程、GitKraken 教程、Sourcetree 教程、IntelliJ IDEA 教程 等你可以根据习惯选择任意一款 GUI 工具完成本文的流程。对于不熟悉命令行CLI的开发者Sublime Merge 的优势在于仓库状态、分支、暂存区、提交历史都以可视化的方式呈现所有 Git 操作通过菜单和按钮完成无需记忆命令。本文的流程对应的是波斯语教程 sublime-merge-tutorial-fa.md英文原版见 sublime-merge-tutorial.md并补充了仓库中的底层实现与命令行对照帮助你同时建立 GUI 操作与 Git 原理的映射。第一步Fork复刻这个仓库在 first-contributions 仓库页面顶部点击Fork按钮系统会在你的 GitHub 账号下创建一份该仓库的完整副本。这一步的意义在于开源项目的核心仓库通常没有直接写入权限你无法直接向别人的仓库提交改动。Fork 相当于把项目复制到自己的名下让你拥有完全的控制权之后你在自己的副本上任意修改、提交、推送再通过 Pull Request 请求原仓库维护者合并你的改动。Fork 出来的副本与上游仓库是相互独立又相互关联的两个仓库这一三角关系正是开源协作的基础形态。第二步Clone克隆仓库到本地在 Sublime Merge 中进入File - Clone Repository文件 → 克隆仓库菜单。接下来的关键一步是把你的 fork 克隆到本地机器这样你才能开始修改代码。Sublime Merge 需要你提供仓库的 URL回到 GitHub 上你自己的 fork 仓库页面点击Code按钮再点击复制到剪贴板图标复制 URL。务必小心新手最常犯的错误是克隆了你 fork 自它的那个原仓库而不是克隆你自己的 fork。请在克隆前检查浏览器地址栏确保复制的是你账号下的仓库地址而不是 first-contributions 原始仓库的地址。将 URL 粘贴进 Sublime Merge 后可以给仓库起一个名字也可以留空使用默认名并设置仓库要保存到的本地目录。确认路径无误后点击Clone按钮Sublime Merge 会开始拉取仓库的全部内容到本地。命令行对照这一步在终端中对应git clone 你复制的URL例如git clone gitgithub.com:this-is-you/first-contributions.git其中this-is-you是你的 GitHub 用户名。克隆下来的本地目录即为first-contributions见 README.md。第三步创建分支Branch在 Sublime Merge 中创建分支有两种方式右键点击左侧面板的Branches分支选择Create Branch创建分支或者通过顶部菜单Repository - Create Branch仓库 → 创建分支。将分支命名为add-your-name的格式例如add-william-sutton、add-your-username。以你的名字或用户名命名分支是开源社区约定俗成的良好实践每个贡献者的改动隔离在独立分支上互不干扰维护者一看分支名就能知道这个分支改了什么、是谁提交的一个分支对应一个 PR评审和合并都有清晰上下文。命令行对照在终端中对应git switch -c add-your-branch-name老版本 Git 可用git checkout -b add-your-branch-name详见 README.md。第四步修改文件并提交Commit现在打开仓库根目录下的 Contributors.md 文件把你的名字添加到名单中然后保存文件。如果你在 Sublime Merge 中打开了这个仓库会立即看到界面提示出现了改动选择最顶部标注为x unstaged filesx 个未暂存文件的最新条目即可看到被修改的文件列表。接下来需要理解 Git 的核心概念——暂存staging暂存区staged你明确告诉 Git本次提交要包含这些改动的区域未暂存unstaged工作区中已经发生、但尚未纳入本次提交的改动暂存之所以重要是因为它能精确指定哪些文件改动与本次提交关联避免把无关的中间修改混进提交里。操作步骤为审查已变更的文件决定哪些要纳入本次提交给提交写一条消息commit message推荐使用描述性文案例如Add to Contributors list把你的名字加入贡献者名单对改动满意的文件逐个暂存stage或直接点击stage all全部暂存一次处理点击Commit提交按钮。首次提交时 Sublime Merge 会要求填写你的用户名username和邮箱地址email填写后点击Update保存为你的 Git 身份信息再次点击Commit完成提交。如果中途改变主意你可以将已暂存的改动取消暂存unstage也可以discard丢弃所有改动。警告正如 discard 一词所暗示的这是一项破坏性操作。丢弃意味着彻底放弃这些改动且不可恢复只有当你确定不想要当前仓库中的任何改动时才能执行。日常练习时建议只用 unstage 反悔谨慎使用 discard。命令行对照本步对应git status查看改动、git add Contributors.md暂存、git commit -m Add your-name to Contributors list提交详见 README.md。到这里你已经把改动提交到了本地仓库中自己分支的副本上——也就是说改动目前只存在于你的电脑里还没有同步到 GitHub。第五步推送Push改动到 GitHub将本地提交同步到远程仓库在 Sublime Merge 中有两种入口顶部菜单Repository - Push仓库 → 推送或点击界面右上角朝上的小箭头按钮。首次推送时Sublime Merge 会弹出登录窗口用你的 GitHub 用户名和密码登录实际使用中建议在 GitHub 账号设置中配置访问令牌遵循平台的认证要求。推送目标的选择如果你希望改动直接反映到main主分支上将改动推送到origin分支更规范的做法是选择你创建的那个特性分支如add-your-name进行推送这样改动与主分支隔离便于后续发起 PR。命令行对照本步对应git push -u origin your-branch-name-u用于首次推送时建立本地分支与远程分支的关联详见 README.md。推送过程中若遇到身份认证失败README 也给出了通过git remote -v检查远程地址、用git remote set-url origin修正远程地址的建议。第六步发起 Pull RequestPR提交你的改动供评审推送完成后回到 GitHub 上你的 fork 仓库页面会看到一个醒目的Compare pull request比较并创建拉取请求按钮点击它GitHub 会打开一个对比页面展示你的分支相对于目标仓库 main 分支的差异确认对比结果无误后填写 PR 的标题和说明可以沿用你的提交信息如 Add to Contributors list点击提交按钮正式发起 Pull Request。提交 PR 后上游仓库的维护者会收到通知。对于 first-contributions 项目维护者会将你的改动合并进项目的 main 分支——合并完成后你会收到一封通知邮件。至此你的第一次开源贡献宣告完成。完成之后下一步去哪里恭喜你刚刚完整走完了开源贡献中最常遇到的fork → clone → edit → PR标准流程这个流程在你今后以贡献者身份参与任何开源项目时都会反复出现。在此基础上你可以继续深入补充学习高级 Git 技巧本仓库的 additional-material 汇总了一系列进阶主题包括修改最近一次提交amending-a-commit.md、解决合并冲突resolving-merge-conflicts.md、将 fork 与上游仓库保持同步keeping-your-fork-synced-with-this-repository.md、压缩提交squashing-commits.md、回退提交reverting-a-commit.md等。其中保持 fork 同步尤为重要它解释了上游仓库、你的 fork、你的本地仓库三者构成的三角工作流Triangle Workflows并给出git remote add upstream、git fetch upstream、git rebase upstream/main、git push origin main的完整同步命令序列——当 GitHub 提示你的 fork 落后于上游若干提交时就该执行这一流程。查看其他工具的教程如果 Sublime Merge 不是你的首选仓库还提供了 GitHub Desktop、VS Code、GitKraken、Sourcetree、IntelliJ IDEA 以及命令行CLI等多套完整教程流程完全一致工具随你挑选。阅读波斯语相关文档本仓库的 README 提供了包括 波斯语版本 README 在内的数十种语言翻译方便不同语言背景的贡献者阅读。小结GUI 操作与 Git 原理的对照阶段Sublime Merge 操作底层 Git 命令见 README.md核心要点克隆File - Clone Repositorygit clone url克隆自己的 fork而非上游原仓库建分支Branches - Create Branch / Repository - Create Branchgit switch -c branch命名规范add-your-name暂存与提交逐个 stage 或 stage all填写 commit message 后 Commitgit add Contributors.mdgit commit -m ...首次提交需设置用户名与邮箱discard 是破坏性操作推送Repository - Push 或右上角向上箭头git push -u origin branch首次需登录 GitHub 账号发起 PR在 GitHub fork 页面点击 Compare pull request无网页操作合并成功后收到通知邮件整个流程走下来你不仅完成了一次真实的开源贡献还顺带掌握了 Git 分支隔离、暂存区管理、远程推送与 PR 协作这几项贯穿所有开源项目的核心能力。放松心态跟着步骤走享受你的第一次开源之旅吧。【免费下载链接】first-contributions✨ Help beginners to contribute to open source projects项目地址: https://gitcode.com/gh_mirrors/fi/first-contributions创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考