用途
ticket-format 定义 superset-sh/superset 仓库中 Linear 与 Superset 工单的统一格式,用于在创建、起草(drafting)或梳理(grooming)工单时保持结构一致。
主要结构与能力
工单按三段式组织:
- Context:用 2–4 句话说明哪里出了问题或需要什么,以及原因。要求以结果为导向,而非以解决方案为导向。
- References:记录工单来源。若没有来源,可省略该部分。示例字段包括 Source(如 Slack #feedback)、Who(如 @alice)、Link(如 thread)、Date(如 2026-05-10)。
- Implementation notes:由智能体梳理时填写。若缺少代码库上下文,保持为空,等待后续梳理补充。填写时使用以下子标题,并跳过不适用项:
-
Files:path:line + 相关原因
-
Approach:一段话
-
Related code:仓库中类似模式
-
Gotchas:约束条件、既往事故
-
使用方式
在创建或梳理工单时,按照上述三段结构撰写;Implementation notes 视是否具备代码库上下文决定留空或填写。资料未提供具体命令、安装步骤或工具调用方式。
适用场景
适用于本仓库内 Linear 和 Superset 工单的创建、起草与梳理。
限制
资料仅描述格式规范,未提供自动化校验、模板文件、平台集成细节或收费信息。