如何为开源项目提交pr
作者:互联网
在CNCF:community bridge#1285Reading Material Update And Supplement
这个议题当中,更新扩充好的材料需要同步更新到volcano官网的官方文档上,这篇文章主要来记录如何为开源项目(volcano)提交pr,以达到我们将贡献的开源文档同步更新到官网上。
创建自己的分支
这里的步骤包括如下几个小步骤
- fork开源项目
- 创建本地代码仓库
- 本地代码仓库更新
- push本地更新到远程仓库
这里重点记录一下本地代码仓库的更新。因为我们这里更新的是官方文档,这里官网的文档维护是使用https://github.com/volcano-sh/website这个框架,其是一个基于hugo
自动渲染的前端框架,因此我们在更新本地仓库的文档的时候,需要在本地安装配置hugo,在本地进行更新调试,然后确保我们的分支代码在格式没有错误的条件下,才能向社区提交PR。
这里的工作具体而言,分为如下几个步骤
1.本地安装hugo。我是OS X,用如下命令进行安装配置。
brew install hugo
2.终端cd到本地的代码仓库/website下,执行如下命令。
hugo server -D
访问//localhost:1313/
即可开始本地的调试。
在开源项目的官方github提交PR
创建了有自己贡献版本的分支并使用hugo本地调试完成之后,需要将自己的分支版本提交给社区,在社区的github页面create pull request提交自己的分支版本即可。
参考:https://github.com/volcano-sh/website
标签:pr,提交,hugo,更新,开源,文档,本地,volcano 来源: https://www.cnblogs.com/rhythmic/p/14614745.html