同步操作将从 KodeRover/zadig 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
首先,非常感谢你使用 Zadig
Zadig 是一套分布式开源的持续部署系统,和其它 CI/CD 不同,Zadig 不仅可以提供高可用的 CI/CD 能力,同时内置很多面向不同技术场景的最佳实践。
Zadig 的成长离不开大家的支持。我们欢迎各类贡献,小到修改错别字、更新文档链接,大到负责从设计到研发的一个完整的功能。如果你愿意为其贡献代码或提供建议, 请阅读以下内容。
每个 commit 都需要加上 Developer Certificate of Origin。这是一个很轻量的操作,具体可以见这里。
同时还想提醒大家遵循社区的 Code of Conduct,Zadig的良好发展离不开一个健康的社区,希望大家能一起维护。
请先 fork 一份对应的仓库,不要直接在仓库下建分支。然后可以参考 Zadig 开发流程 的介绍将 Zadig 环境搭建起来。
在决定提交 issue 或者提交任何更改之前,请查一下项目的 open issues,避免重复。我们也准备 了几个 issue label 来帮助大家筛选:
如果想上报的是和 security 相关的问题,请不要通过提交issue,而是发邮件到 contact@koderover.com。 如果不是 security 相关的问题,请接着阅读这一章节。
贡献者提交 issue 的时候,有以下五种类型需要考虑:
如果贡献者知道自己的 issue 是明确关于哪个或者哪几个服务的,也建议将服务相对应的 label 加上去:具体请搜索我们带service/
前缀的 label;如果不确定的话可以放着,我们的 maintainer 会加上。
请首先检查下我们的 open issues,确保不要提交重复的 issue。确认没有重复后,请选择上面类型之一的 label,并且按 issue 模板填好,尽可能详细的解释你的 issue —— 原则是要让没有你 context 的别人也能很容易的看懂。
我们项目的 maintainer 会监控所有的 issue,并做相应的处理:
duplicate
: 重复的 issuewonfix
:决定不采取行动。maintainer 会说明不修复的具体原因,比如
work as intended, obsolete, infeasible, out of scopegood first issue
:见上文,适合新人上手的 issue。good intermediate issue
: 见上文,比较
进阶的 issue,欢迎社区的贡献者来挑战。对于非常简单的文档改动,比如改个错别字、更新个链接之类的,不需要走什么流程,直接建一个 PR 就行。我们的 Maintainer 会去 review。对于 PR 的具体要求,请参见 我们的 PR / Commit 指导。
如果你想对文档做一些复杂点的改动,比如重塑文档的结构、增加一个新文档、添加几个章节等等,具体要求请遵循进阶的代码改动。你将会需要一个 issue 来跟踪,并且需要先提交你的改动方案并且方案被我们的 maintainer 通过。
对于任何的代码改动,你都需要有相应的 issue 来跟踪:不管是现有的 issue 还是创建一个新的 issue。
请在对应的 issue 下留言,表明你要 WORK ON 这个 issue,避免重复
对于简单的代码改动,我们的指导如下:
aslan
service 的 API, 你需要相应的更新我们的API文档.对于没那么直观或者稍微复杂点的代码改动:
yyyy-MM-dd-my-design-name.md
格式命名,并且放到 community/rfc目录下。为这个设计方案提交
一个单独的 PR,我们的 maintainer 会去 review。如果你更改的不是 aslan
service 的 API,那不需要考虑这个步骤。我们目前只对 aslan
维护API文档。
aslan
的文档参阅这里:我们用Swag自动生成Swagger文档;Swag会根据代码中API的注释(遵循swag declarative API comments),自动生成文档.
所以如果你添加或者修改了任何 aslan
的API, 需要做以下几件事:
aslan
的API文档:cd [your root path of Zadig-X]
swag init -d ./lib/microservice/aslan/ -g server/rest/router.go -o ./lib/microservice/aslan/server/rest/doc
更多细节参考 Swag CLI。
注意:如果你生成的doc/docs.go包含"github.com/alecthomas/template"(较早的swag版本),请将它改成标准库"text/template"
/api/aslan/apidocs/index.html
.我们有清晰的开发者的晋级之路,请参见我们的 GOVERNANCE 文档。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。