Skip to content

贡献者指南

scarqin edited this page Apr 26, 2022 · 3 revisions

你好,新朋友,感谢你决定为 Eoapi 做贡献!希望我们可以一起共建一个友好,开放、透明的社区。

如果你是个开源新手,在我们开始前请先阅读如何为开源做贡献

参与开源贡献的方式可不止写代码一种,Eoapi 支持的贡献方式有:

  • 提交 Issue
  • 发布 Eoapi 插件
  • 完善官方文档
  • 提交代码 pull request
  • 在各大社区回答关于项目的问题
  • 在各大社区宣传 Eoapi

接下来我们详细看看每个部分如何开始:

提 Issue

第一步,首先看看是否有其他人提过相应的问题,如果提过了,可以加个表情表示你也在关注,一般来说关注者越多,问题响应速度就会越快。

如果你是第一个踩坑的“幸运儿”,请尽快提出你的问题鞭笞官方/社区协助解决。

创建 Issue

创建入口

如何选择 Issue 的 tag?

创建后请选中和主题相关的标签,支持多选

  • bug:提交产品 Bug
  • documentation:和官方文档、项目文档等文档相关的 Issue
  • enhancement:原有功能基础之上的附加需求
  • feature-request:现在没有的功能需求
  • good first issue:超适合初学者贡献的 Issue
  • help wanted: 适合社区贡献者贡献的 Issue,比 good first issue 适用范围大一些
  • invalid:无效提问
  • question:需要提供更多信息才能判断的 Issue,相当于等待状态
  • wontfix:不会支持的功能/误以为是 bug 但实际是官方精心设计的功能相关的 Issue

如何跟进 Issue

发布 Eoapi 插件

提交代码

为了能帮助你开始你的第一次尝试,我们用 good first issues 标记了一些比较容易修复的 bug 和小功能。这些 Issue 可以很好地作为你的首次尝试。

提交流程:如何优雅地在 GitHub 上贡献代码

完善官方文档

官方文档地址 我们可以找到想要贡献的官方文档,拉到页面最底部,点击贡献此文档提交一个 pull request。 如果你想提交一个新的文档,可以到官方文档 Github 项目 fork 仓库后提交 pull request