ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

first-contributions 信德语指南解读:从 Fork 到 Pull Request 的首次开源贡献完整工作流

first-contributions 信德语指南解读:从 Fork 到 Pull Request 的首次开源贡献完整工作流 first-contributions 信德语指南解读从 Fork 到 Pull Request 的首次开源贡献完整工作流【免费下载链接】first-contributions✨ Help beginners to contribute to open source projects项目地址: https://gitcode.com/gh_mirrors/fi/first-contributions本文基于 docs/translations/README.sindhi.mdfirst-contributions 项目的信德语翻译版 README整理成文并结合仓库内的英文主文档 README.md、贡献者名单 Contributors.md 与附加材料目录系统讲解一条面向零基础新手、可直接照做的开源贡献路径。读完本文你将掌握fork → clone → branch → commit → push → pull request这条标准贡献工作流中的每一个命令及其作用并了解提交合并后还有哪些进阶 Git 操作可以继续学习。项目定位降低第一次贡献的心理门槛first-contributions 项目的核心立意非常朴素第一次做任何事都很难第一次向开源项目提交代码尤其如此——犯错并不是一件令人舒服的事。项目希望为刚接触开源的新贡献者打开一条低门槛的通道让新手能真正完成自己的第一次贡献而不仅仅是阅读教程。为此项目特意选择了一个无代码内容的提交目标Contributors.md当前仓库中该文件已积累了数千行贡献者名单。贡献者只需把自己的名字加进这份名单即可完整走一遍真实的开源贡献流程而不必担心写错代码。这一设计让实操环境取代了阅读教程正是项目文档所强调的读文章、看视频教程固然有帮助但真正在真实环境里动手做一遍学习效果要好得多。信德语版文档位于 docs/translations/README.sindhi.md英文原版为 README.md。若需阅读其他语言版本可查看 docs/translations/Translations.md 中的语言索引。准备工作确认 Git 环境并 Fork 仓库在开始之前需要确保本机已安装 Git。如果尚未安装请先根据对应平台的安装指南完成安装仓库内提供了 installing-git-ubuntu.md 与 installing-git-arch.md 两份针对 Ubuntu 和 Arch Linux 的安装文档。Fork 这个仓库Fork分叉是在不直接修改原仓库的前提下把仓库复制一份到自己的 GitHub 账号下。操作方式很简单打开 first-contributions 仓库页面点击页面顶部的Fork按钮GitHub 就会在你的账号下创建一份仓库副本。Fork 的意义在于你获得了一个可以自由写入的远程副本后续所有修改都可以先推送到自己的 Fork 上再通过 Pull Request 请求原仓库合并从而避免未经许可直接改动他人的项目。克隆仓库到本地Fork 完成后需要把远程副本克隆到本地机器进入你的 GitHub 账号打开刚 Fork 出来的仓库。点击Code按钮再点击复制图标将仓库地址复制到剪贴板英文原版 README 中还特别提示可以切换到 SSH 标签页复制 SSH 地址。打开终端执行克隆命令git clone 你刚复制的 URL其中你刚复制的 URL去掉引号就是你 Fork 出来的仓库地址。示例git clone https://github.com/this-is-you/first-contributions.git这里this-is-you是占位符实际应替换为你的 GitHub 用户名。执行后first-contributions 仓库的全部内容会被复制到你的电脑上。创建自己的功能分支克隆完成后先进入仓库目录cd first-contributions然后使用git switch命令创建并切换到一个新分支git switch -c your-new-branch-name示例分支名使用add-前缀是社区惯例因为这条分支的目的就是把你的名字添加进名单git switch -c add-alonzo-church分支名并不强制要求包含add-前缀但加上它能让分支用途一目了然便于他人审阅。兼容性提示如果执行git switch时出现switch is not a git command之类的错误说明你的 Git 版本较旧请改用git checkout的等价写法git checkout -b your-new-branch-name英文原版 README.md 同样提供了上述两种命令并指出git switch是较新版本 Git 推荐的分支切换方式。做出修改并提交把自己写进 Contributors.md修改文件用文本编辑器打开 Contributors.md把你的名字添加进去。文档特别强调不要加在文件开头或结尾而是加在文件中间任意位置。这一约定一方面是为了减少大量贡献者同时修改首尾行时产生的合并冲突概率另一方面也锻炼了编辑大文件的能力。保存文件后回到项目目录执行git status可以看到工作区出现了变更记录——这是 Git 对文件修改状态的实时反馈也是后续add、commit操作的基础。暂存与提交先把你创建的变更添加到暂存区git add Contributors.md再将暂存内容提交为一个 commit提交信息示例git commit -m Add your-name to Contributors list把your-name替换为你的真实名字即可。commit 是 Git 工作流的核心动作它把一组相关变更固化成一条带说明的记录形成项目历史中的一步。推送到 GitHub本地提交完成后需要把分支推送到远程即你 Fork 的仓库使用git pushgit push -u origin your-new-branch-name-u即--set-upstream的作用是建立本地分支与远程分支的追踪关系这样后续再执行git push时无需重复指定分支名。请把your-new-branch-name替换为你创建的分支名。推送报错怎么办英文原版 README 给出了两类常见推送错误的处理思路认证失败GitHub 已于 2021 年 8 月 13 日起移除了对密码认证的支持推送时需要使用 Personal Access Token 或 SSH 密钥。可先用git remote -v检查远程地址若远程地址是https://形式且反复提示用户名密码可改用 SSH 地址git remote set-url origin gitgithub.com:your-username/your_repo.gitSSH 密钥未配置需要先在 GitHub 账号中生成并添加 SSH 公钥才能使用gitgithub.com:...形式的远程地址。提交 Pull Request推送成功后回到 GitHub 上你自己的 Fork 仓库页面会看到一个Compare pull request按钮点击它然后提交 Pull RequestPR。提交后项目维护者会审查你的改动并在合适的时候把它合并进项目的主分支。合并完成后你会收到一封通知邮件。至此你已经完整走完了fork → clone → edit → pull request这条在真实开源协作中反复出现的标准工作流。提交之后分享、实践与继续深入分享与寻找更多练手项目首次贡献值得庆祝可以通过项目配套的 Web 应用把这次贡献分享给朋友和关注者。如果想继续练习代码类贡献项目还整理了带简单 issue 的项目清单可以从中挑选起步项目。附加学习材料仓库在 docs/additional-material/git_workflow_scenarios/additional-material.md 中汇总了一批针对已完成基础教程读者的进阶 Git 场景文档覆盖了贡献者高频遇到的真实问题场景文档解决的问题amending-a-commit.md修改最近一次尚未推送的提交如更正提交信息、补漏文件configuring-git.md配置用户信息等 Git 全局选项keeping-your-fork-synced-with-this-repository.md让 Fork 跟上原仓库的最新提交moving-a-commit-to-a-different-branch.md把提交移动到另一个分支removing-a-file.md在提交前从本地仓库移除文件removing-branch-from-your-repository.mdPR 合并后清理本地分支resolving-merge-conflicts.md解决合并冲突reverting-a-commit.md撤销已推送到远程的提交squashing-commits.md用交互式 rebase 把多个提交压缩成一个undoing-a-commit.md撤销/重置本地提交stashing-a-file.md暂存未提交的改动storing-credentials.md安全存储仓库凭据creating-a-gitignore-file.md创建.gitignore控制哪些文件不入库gitflow.md了解 Git Flow 分支模型rebase-vs-merge.md理解 rebase 与 merge 的差异与取舍这些文档与本文的核心教程构成了一条完整的学习阶梯先用一次真实的 PR 跑通协作流程再逐步掌握日常贡献中最常用的 Git 高级操作。不习惯命令行试试 GUI 教程信德语版文档与英文版一致为不熟悉命令行的读者准备了使用图形界面工具的教程覆盖多种主流客户端GitHub Desktop 教程Visual Studio 2017 教程GitKraken 教程Visual Studio Code 教程Atlassian Sourcetree 教程IntelliJ IDEA 教程这些教程与命令行教程走的是同一套 fork、clone、分支、提交、推送、PR 的流程只是操作载体从终端变成了图形界面适合偏好可视化操作的新手。小结first-contributions 的价值在于把第一次开源贡献这个心理门槛极高的动作拆解成了一条任何人都能照做的五步路径Fork把仓库复制到自己的 GitHub 账号Clone克隆到本地机器Branch创建独立的功能分支git switch -cCommit在 Contributors.md 中加入自己的名字并git add、git commitPush PRgit push -u origin推送到远程再发起 Pull Request 等待合并。完成这五步你就掌握了开源协作中最常见的工作流骨架而仓库内 docs/additional-material 下的进阶文档则为这条骨架补充了合并冲突、提交改写、分支同步等真实场景下的肌肉记忆。无论你未来参与哪个开源项目这套方法论都直接适用。【免费下载链接】first-contributions✨ Help beginners to contribute to open source projects项目地址: https://gitcode.com/gh_mirrors/fi/first-contributions创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表