本文描述了如何参与github
的项目合作:包括将要修改的项目fork到本地,修改后再提交到github的详细过程。
我最近发现了一个特别好的做博客的框架:
hugo-PaperMod
。
在使用它的过程中,发现了一些中文国际化方面的不足,特别想把这些收获奉献给后来者。
-
Fork 项目 访问您想要修改的开源项目的 GitHub 页面。 点击页面右上角的
Fork
按钮,将项目复制到您的 GitHub 账户中。 -
克隆到本地 在您的 GitHub 页面中找到
Fork
之后的项目,并复制项目的克隆URL
。 在您的本地终端执行以下命令,将项目克隆到本地:
git clone <克隆URL>
- 创建新的分支 在克隆的项目目录中创建一个新的分支,以保持修改与主分支分开:
git checkout -b <feature-branch-name>
建议分支名称描述您的修改内容,例如 fix-typo
或 add-new-feature
。
- 修改代码 在本地编辑代码,完成所需的修改。 修改完成后,保存并在终端中查看修改状态:
git status
- 提交修改 添加您想提交的修改:
git add .
提交更改,并写上有意义的提交信息:
git commit -m "描述您的修改"
- 推送到您的 GitHub 分支 将您的修改推送到 GitHub 中的对应分支:
git push origin <feature-branch-name>
-
创建
Pull Request
(PR
) 打开您的 GitHub 项目页面,您会看到一个提示,询问是否要创建Pull Request
。 点击Compare & pull request
按钮。 填写PR
的标题和描述,说明您做了哪些修改以及原因。 确认无误后,点击Create pull request
提交。 -
等待项目维护者的反馈 项目维护者会审核您的
PR
,如果有问题,他们可能会在PR
下留言。 根据反馈,您可能需要进行进一步修改,然后推送到同一个分支,更新P
R。
完成以上步骤后,您的贡献将等待项目维护者的审核,审核通过后将合并到主项目中。