贡献编辑

无论您是想修复错误、实现功能、添加改进还是添加 API,以下部分将指导您完成流程。提交代码后,请查看 Elastic 贡献者计划,您可以在其中为您的贡献赚取积分和奖励。

阅读 入门 以启动您的环境,然后阅读 最佳实践.

签署贡献者许可协议编辑

请确保您已签署 [贡献者许可协议](https://elastic.ac.cn/contributor-agreement/)。我们不是要求您将版权转让给我们,而是要求您授予我们无限制地分发您的代码的权利。我们要求所有贡献者这样做,以确保我们的用户了解代码的来源和持续存在。您只需签署一次 CLA 即可。

本地化编辑

阅读 本地化 以了解有关我们本地化实践的详细信息。

请注意,我们无法支持接受来自除我们聘请的翻译人员以外的任何来源的翻译贡献。我们尚未开发出适当的流程来接受任何贡献的翻译。我们当然感谢人们足够关心本地化工作,希望帮助提高质量。我们的目标是为将来构建更全面的本地化流程,并在 Kibana 支持外部贡献时通知您。但是,目前,我们无法合并建议。

发布说明流程编辑

此流程的一部分仅适用于维护者,因为它需要访问 GitHub 标签。

Kibana 发布了针对主要和次要版本的 发布说明。发布说明总结了 PR 在对用户有意义的语言中所完成的工作。为了生成发布说明,团队会对这个仓库运行一个脚本,以收集针对该版本的合并 PR。

创建发布说明文本编辑

发布说明中显示的文本直接从您的 PR 标题中提取,或者从您在 PR 描述中指定的单段文本中提取。

要使用单段文本,请在 PR 描述中输入一个 Release note:## Release note 标题(“dev docs” 也行),然后输入您的文本。例如,请参考此 PR,它使用了 ## Release note 标题。

创建发布说明文本时,请使用以下最佳实践

  • 使用主动语态。
  • 使用句子大小写。
  • 创建添加功能的 PR 时,以 Adds 开头。
  • 创建改进现有功能的 PR 时,以 Improves 开头。
  • 创建修复现有功能的 PR 时,以 Fixes 开头。
  • 创建弃用功能的 PR 时,以 Deprecates 开头。

添加您的标签编辑

要确保您的 PR 包含在发布说明中,请添加正确的标签。

  1. 使用目标版本标记 PR(例如:v7.3.0)。
  2. 使用适当的 GitHub 标签标记 PR

    • release_note:feature — 新的用户界面功能、对功能的重大增强以及重大错误修复(在极少数情况下)。
    • release_note:enhancement — 次要的 UI 更改和增强。
    • release_note:fix — 修复先前版本中存在的错误。
    • release_note:deprecation — 弃用先前版本中存在的功能。
    • release_note:breaking — 先前版本中不存在的重大更改。
    • release_note:skip — 不应出现在发布说明中的更改。例如,文档、构建和测试修复,或仅在 main 中的未发布问题。