正在加载

贡献

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

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

请确保您已签署贡献者许可协议。我们不是要求您将版权转让给我们,而是给我们不受限制地分发您的代码的权利。 我们要求所有贡献者这样做,以向我们的用户保证代码的来源和持续存在。您只需要签署一次 CLA。

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

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

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

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

发行说明中出现的文本直接从您的 PR 标题或您在 PR 描述中指定的单个段落的文本中提取。

要使用单个段落的文本,请在 PR 描述中输入一个Release note:## Release note 标头(“dev docs”也可以),后跟您的文本。例如,请参阅此PR,该 PR 使用了 ## Release note 标头。

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

  • 使用主动语态。
  • 使用句子大小写。
  • 当您创建一个添加功能的 PR 时,请以 添加 开头。
  • 当您创建一个改进现有功能的 PR 时,请以 改进 开头。
  • 当您创建一个修复现有功能的 PR 时,请以 修复 开头。
  • 当您创建一个弃用功能的 PR 时,请以 弃用 开头。

要确保您的 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 中的未发布问题。
© . All rights reserved.