New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
« 报表集成 我们如何使用 Git 和 GitHub »
Elastic 文档 ›Kibana 指南 [8.17] ›开发者指南

贡献

编辑

贡献

编辑

无论您是想修复 bug、实现新功能、添加改进还是添加 API，以下部分都将指导您完成整个过程。提交代码后，请查看 Elastic 贡献者计划，您可以通过贡献赚取积分和奖励。

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

签署贡献者许可协议

编辑

请确保您已签署 贡献者许可协议。我们并非要求您将版权转让给我们，而是给予我们无限制分发您的代码的权利。我们要求所有贡献者都这样做，以确保我们的用户了解代码的来源和持续存在。您只需签署一次 CLA。

本地化

编辑

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

请注意，我们无法支持接受来自我们雇用的翻译人员之外的任何来源的翻译贡献。我们尚未开发出接受任何贡献翻译的适当流程。我们当然感谢人们关心本地化工作，并希望帮助提高质量。我们的目标是在未来建立一个更全面的本地化流程，一旦 Kibana 支持外部贡献，我们将通知您。不过，目前我们无法采纳建议。

发行说明流程

编辑

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

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

创建发行说明文本

编辑

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

要使用单个段落的文本，请在 PR 描述中输入 Release note: 或 ## Release note 标题（“dev docs”也适用），后跟您的文本。例如，请参考使用 ## Release note 标题的这个 PR。

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

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

添加您的标签

编辑

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

  1. 使用目标版本标记 PR（例如：v7.3.0）。

  2. 使用适当的 GitHub 标签标记 PR

    • release_note:feature — 面向用户的新功能，对功能的重大改进，以及重要的 bug 修复（在极少数情况下）。
    • release_note:enhancement — 次要的 UI 更改和增强。
    • release_note:fix — 修复先前版本中存在的 bug。
    • release_note:deprecation — 弃用先前版本中存在的功能。
    • release_note:breaking — 先前版本中不存在的破坏性更改。
    • release_note:skip — 不应出现在发行说明中的更改。例如，文档、构建和测试修复，或者仅在 main 中的未发布问题。
« 报表集成 我们如何使用 Git 和 GitHub »

On this page

Was this helpful?
Feedback