Loki 改进文档 (LID)
目的
Loki改进文档 (LID) 是修改 Grafana Loki 功能集和/或流程的提案。这些文档旨在在大规模修改 Grafana Loki 之前,促进社区与维护者之间的互动。这确保了我们将只致力于维护者和社区**真正需要**的功能,并且这些功能将按照 Loki 的工程和可扩展性考量来实现。
以下情况**不需要** LID:
- 错误修复
- 次要功能
- 次要流程更改
创建 LID
首先,使用此模板针对此仓库提交 PR。
所有 LID 都需要一个“发起人”。发起人是 Grafana Loki 的维护者,他们愿意在改进提案的整个开发过程中,从草案阶段直到完成,提供指导。您可以通过在我们的邮件列表中发起一个讨论串来找到发起人,一个或多个维护者会回复并自愿担任。如果 LID 是由同时也是维护者的 Grafana Labs 员工内部产生的,则发起人将是作者。讨论串主题应以“LID: ”开头。
LID 应包含问题的概览、提议的解决方案以及模板中指定的其他详细信息。LID 可以选择关联一个粗略的原型实现 PR,但建议不要在此上花费太多时间,因为提案可能会拒绝。
LID 将永久可见,并用于记录我们的决策以及所有促成这些决策的输入和推理。
流程
提交 PR 后,发起人以及感兴趣的社区成员和维护者将对其进行评审。LID 需要发起人和另一位维护者批准后方可接受。一旦接受,即可开始改进工作,指定的发起人将评审所有进一步的相关贡献。
注意事项
- LID 接受后将分配一个编号。
- 在合并添加 LID 的初始 PR 后,LID 必须由发起人或作者保持最新,以反映其当前状态。
- 当 LID 被拒绝或改进已包含在发布版本中时,该 LID 被视为已完成。
CHANGELOG
条目应酌情引用 LID。- 对 LID 流程的重大修改应通过 LID 提出。
- 应在 Slack 的
#loki
频道与社区共享 LID 以征求意见,并且发起人应等待**至少 2 周**后再接受提案。