DataLinkDC Dinky项目Issue提交规范指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_01091/article/details/148577679

DataLinkDC 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系统是开发者与用户沟通的重要桥梁。对于DataLinkDC Dinky这样的实时计算平台项目，良好的Issue管理能够有效促进项目健康发展。本文将详细介绍如何在Dinky项目中规范提交Issue，帮助开发者高效参与项目协作。

Issue的基本概念

Issue是项目开发过程中用于追踪任务、讨论问题和记录需求的工作单元。在Dinky项目中，Issue主要分为以下几类：

功能请求(Feature)：用于提出新功能需求
缺陷报告(Bug)：用于报告系统中存在的问题
改进建议(Improvement)：针对现有功能的优化建议
测试相关(Test)：专门针对测试用例的讨论
子任务(Sub-Task)：大功能拆解后的小任务

Issue标题规范

Dinky项目采用标准化的Issue标题格式，便于分类和管理：

[`Issue类型`][`模块名`] `Issue描述`

Issue类型说明

| 类型 | 适用场景 | 示例 | |--------------|-------------------------------------|-----------------------------------| | Feature | 新功能需求 | [Feature][admin] 新增用户管理功能 | | Bug | 系统缺陷 | [Bug][executor] 任务执行异常 | | Improvement | 性能优化、代码改进等 | [Improvement][core] 优化SQL解析 | | Test | 测试用例相关 | [Test][metadata] 增加MySQL元数据测试 | | Sub-Task | 大功能拆解的子任务 | [Sub-Task][web] 实现前端页面布局 |

模块名说明

Dinky项目采用模块化设计，主要模块包括：

| 模块名 | 功能描述 | |--------------|----------------------------| | admin | 系统管理功能 | | alert | 告警相关功能 | | client | Flink客户端交互 | | core | 核心业务逻辑 | | executor | 任务执行相关 | | metadata | 元数据管理 | | web | 前端界面相关 |

高质量Bug报告撰写指南

提交Bug报告时，请确保包含以下关键信息：

清晰的问题描述：准确说明遇到的问题现象
重现步骤：提供可复现问题的详细操作步骤
预期与实际结果：明确说明期望行为和实际行为差异
环境信息：包括Dinky版本号、操作系统等
日志信息：提供完整的错误日志和堆栈信息
优先级评估：根据影响程度标注优先级(Critical/Major/Minor/Trivial)

示例模板：

**标题**
[BUG][Major] 任务提交后状态显示不正确

**问题描述**
当提交Flink SQL任务后，任务状态始终显示为"运行中"，即使任务实际已失败。

**重现步骤**
1. 登录Dinky系统
2. 创建新的SQL任务
3. 故意编写错误SQL语法
4. 提交任务
5. 观察任务状态

**期望结果**
任务状态应显示为"失败"

**实际结果**
任务状态显示为"运行中"

**环境信息**
- Dinky版本: 0.6.0
- Flink版本: 1.13.2
- 操作系统: CentOS 7

**日志信息**
[ERROR] 2023-01-01 12:00:00 Task failed due to SQL syntax error...

功能请求撰写指南

提出新功能建议时，应包含以下内容：

功能描述：详细说明功能需求和预期行为
价值分析：解释该功能对用户的价值
参考实现：如有类似实现，可提供参考
优先级评估：根据重要性标注优先级

示例模板：

**标题**
[Feature][Minor] 支持任务依赖关系可视化

**功能描述**
希望在任务管理界面增加可视化功能，展示任务间的依赖关系图。

**价值分析**
1. 帮助用户直观理解复杂任务流
2. 便于排查任务执行顺序问题
3. 提升任务编排效率

**参考实现**
Airflow的DAG可视化功能可作为参考