Skip to main content

为 Superset 做贡献

Superset 是一个 Apache 软件基金会项目。 Superset 的核心贡献者(或提交者)主要在以下渠道进行沟通(任何人都可以加入):

更多参考资料:

导览

以下是包含 Superset 相关包的仓库列表:

  • apache/superset 是主仓库,包含在 pypi 上 发布的 apache-superset Python 包。此仓库还包含 Superset 的主要 TypeScript/JavaScript 捆绑包和 react 应用, 位于 superset-frontend 文件夹下。
  • github.com/apache-superset是我们管理 Superset 相关 小工具、分支和 Superset 相关实验性想法的 GitHub 组织。

贡献类型

报告 Bug

报告 Bug 的最佳方式是在 GitHub 上提交 issue。请包括:

  • 您的操作系统名称和版本。
  • Superset 版本。
  • 复现 Bug 的详细步骤。
  • 任何有助于排障的关于您本地设置的细节。

发布 Python 堆栈跟踪时,请使用 Markdown 块引用它们。

请注意,作为 GitHub Issues 提出的特性请求将被移至 Discussions。

提交想法或特性请求

最佳方式是在 GitHub 上开始一个"Ideas" Discussion thread

  • 详细说明其工作原理。
  • 尽量缩小范围,以便于实现。
  • 记住这是一个志愿者驱动的项目,您的贡献和其他人一样受欢迎。

为了提议大型功能或对代码库的重大更改,并帮助引入这些更改,请创建 Superset改进提案(SIP)。 请参阅SIP-0的模板。

修复 Bug

浏览 GitHub issues。标记为 #bug 的 issues 向任何想要实现它们的人开放。

实现特性

浏览 GitHub issues。标记为 #feature 的 issues 向任何想要实现它们的人开放。

改进文档

Superset 总是需要更好的文档, 无论是作为官方 Superset 文档的一部分, 在 docstrings、docs/*.rst 中,甚至在网络上作为博客文章或文章。 有关更多详细信息,请参阅文档

添加翻译

如果您精通英语以外的语言,您可以帮助翻译 Superset UI 中的文本字符串。您可以跳入现有的 语言词典 superset/translations/<language_code>/LC_MESSAGES/messages.po,甚至为全新的语言创建词典。 有关更多详细信息,请参阅翻译

提问

StackOverflow 上有一个专门的 apache-superset 标签。提问时请使用它。

贡献者类型

遵循 Apache 软件基金会(ASF)的项目治理模式,Apache Superset 有一套特定的贡献者角色:

PMC 成员

项目管理委员会(PMC)成员是由 PMC 选举产生以帮助管理项目的人员。 PMC 成员负责项目的整体健康,包括社区发展、发布管理和项目治理。PMC 成员还负责项目的技术方向。

有关 Apache 项目 PMC 的更多信息,请参阅 https://www.apache.org/foundation/governance/pmcs.html

提交者

提交者是由 PMC 选举产生以获得代码仓库写入权限(提交权限)的人员。他们可以修改代码、文档和网站,并接受他人的贡献。

提交者和 PMC 成员的正式名单可以在这里找到。

贡献者

贡献者是以任何形式对项目做出贡献的人员,包括但不限于代码、测试、文档、问题和讨论。

您也可以在这里查看 Superset 项目关于晋升 PMC 成员的指南:https://github.com/apache/superset/wiki/Guidelines-for-promoting-Superset-Committers-to-the-Superset-PMC

安全团队

安全团队是从 PMC 成员、提交者和非提交者中挑选出的一小组人员,负责处理安全问题。

新成员由 PMC 成员通过投票选出。您可以通过发送邮件到 private@superset.apache.org 申请加入团队。 但是,团队应该小而专注,专注于解决安全问题,因此请求将逐案评估,团队规模将保持相对较小,仅限于积极关注安全的贡献者。

此安全团队必须遵循 ASF 漏洞处理流程

每个新的安全问题都在 ASF 的 JIRA Superset 安全项目上追踪为 JIRA 工单。

安全团队成员必须:

  • 与 Apache 软件基金会签订有 ICLA
  • 除非得到安全团队成员的特别授权,否则不得向任何人(包括他们的雇主)透露待决和未解决的安全问题的信息,例如,如果安全团队同意诊断和解决问题需要外部专家的参与。

发布经理,监督 Apache Superset 特定版本发布的贡献者,默认是安全团队的成员。然而,他们不期望积极参与评估、讨论和修复安全问题。

安全团队成员还应遵循以下一般期望:

  • 积极参与评估、讨论、修复和发布 Superset 中的安全问题。
  • 避免在公开论坛上讨论安全修复。拉取请求(PR)描述不应包含任何有关安全问题的信息。相应的 JIRA 工单应包含指向 PR 的链接。
  • 对修复有所贡献的安全团队成员可能在 CVE 报告中被列为修复开发人员,连同他们的工作隶属关系(如果他们选择包括的话)。