如何参与贡献
社区欢迎大家参与贡献,贡献的形式可以不只局限于代码,也欢迎大家在社区分享自己的实践经验,提出使用中遇到的问题,解决社区中的别 人的疑问,帮助完善社区文档等等。这些方面的贡献在社区中最终都会以Issue,Pull Request,Review的形式呈现。 本文会介绍如何提交Issue,Pull Request以及如何进行Review。
Issue
当你对OpenYurt项目有什么问题,建议或是需求,欢迎在社区提交Issue。步骤如下:
- 点击OpenYurt的Issue界面中的
New issue
来新建一个Issue - 选择你要提交的Issue的种类,然后
Get started
- 填写Issue的标题,并在给出的Issue的模板中填充内容
- 最后
Submit new issue
Pull Request
在写代码前,请先检查社区中是否已经有类似的问题正在解决,以免重复劳动。在提交Pull Request前,可以先更新一下本地仓库,使其尽量与OpenYurt最新状态一致,以免后续合入时发生冲突。另外还需要了解一些CI Workflow的过程,这将有助于Pull Request的合入。
当你往自己fork的仓库中提交了新的commit后,可以向OpenYurt仓库提交一个Pull Request,请求OpenYurt合并你的分支。具体步骤如下:
- 通过
git push
将本地代码同步到fork的OpenYurt仓库中 - 登录Github,进入fork的OpenYurt仓库
- 在Pull requests界面中点击
New pull request
,然后可以在下拉列表中选择需要合入的分支 - 点击
Create pull request
,根据模板填入相应信息