Dinky项目Issue提交规范与最佳实践指南

Dinky项目Issue提交规范与最佳实践指南

dinky Dinky is an out-of-the-box, one-stop, real-time computing platform dedicated to the construction and practice of Unified Streaming & Batch and Unified Data Lake & Data Warehouse. Based on Apache Flink, Dinky provides the ability to connect many big data frameworks including OLAP and Data Lake. 项目地址: https://gitcode.com/gh_mirrors/di/dinky

什么是Issue

在Dinky项目中，Issue是用于跟踪和管理项目开发过程中各类任务的核心工具。它不仅是问题报告的平台，更是功能讨论、方案设计和技术交流的重要场所。通过规范化的Issue管理，可以有效提高开发效率和协作质量。

Issue类型详解

Dinky项目将Issue分为五大类型，每种类型都有其特定的用途和规范：

1. 功能请求(Feature)

用于提出新功能或新特性的开发需求。提交前应确保：

• 该功能未被其他Issue提出过
• 功能描述清晰完整
• 说明该功能的普遍适用性

2. 缺陷报告(Bug)

用于报告系统中存在的错误。高质量Bug报告应包含：

• 可复现的详细步骤
• 预期行为与实际行为的对比
• 相关日志和截图
• 影响范围和优先级评估

3. 改进建议(Improvement)

针对现有功能的优化建议，包括但不限于：

• 代码结构优化
• 性能提升方案
• 用户体验改进

4. 测试相关(Test)

专门针对测试用例的Issue，包括：

• 新增测试用例
• 测试覆盖率提升
• 测试框架改进

5. 子任务(Sub-Task)

大型功能的分解任务，便于分阶段实现和跟踪。

模块划分说明

Dinky项目采用模块化架构，Issue需要明确所属模块：

| 模块名称 | 主要功能 | |---------|---------| | admin | 系统管理功能 | | alert | 告警相关功能 | | app | Flink应用管理 | | client | Flink客户端交互 | | metadata | 元数据管理 | | executor | 任务执行引擎 | | web | 前端界面相关 |

高质量Issue编写指南

Bug报告编写要点

1. 标题规范：明确优先级和问题概要

   [BUG][Major] 任务提交时出现空指针异常
   

2. 问题描述：清晰说明问题现象

3. 复现步骤：提供详细的操作步骤

4. 环境信息：包括Dinky版本、Flink版本等

5. 日志信息：完整的错误日志和堆栈信息

6. 附加材料：截图或录屏能极大提高问题定位效率

功能请求编写要点

1. 背景说明：为什么要增加这个功能

2. 功能描述：详细的功能规格说明

3. 设计方案：建议的实现思路

4. 相关参考：其他系统的类似实现

5. 优先级评估：对项目的重要程度

Issue处理流程

1. 提交阶段：按规范创建Issue

2. 讨论阶段：社区成员讨论方案可行性

3. 设计阶段：确定技术实现方案

4. 实现阶段：开发者基于讨论结果进行编码

5. 验证阶段：测试并关闭Issue

常见问题处理

1. 模块不明确：可由维护者后期调整

2. 重复Issue：建议合并讨论

3. 信息不全：维护者应要求补充信息

4. 优先级争议：通过社区讨论达成共识

通过遵循这些规范，可以确保Dinky项目的Issue管理高效有序，为开发者提供清晰的任务指引，最终提升项目的整体质量。

dinky Dinky is an out-of-the-box, one-stop, real-time computing platform dedicated to the construction and practice of Unified Streaming & Batch and Unified Data Lake & Data Warehouse. Based on Apache Flink, Dinky provides the ability to connect many big data frameworks including OLAP and Data Lake. 项目地址: https://gitcode.com/gh_mirrors/di/dinky