Back to Details

create-ticket

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Create Ticket

创建工单

Goal

目标

  • Ticket is created in issue tracker system.
  • 在问题追踪系统中创建工单。

Prerequisites

前提条件

  • ticket-tools
    skill available
  • scratch
    skill available
  • 具备
    ticket-tools
    技能
  • 具备
    scratch
    技能

Input

输入

Source: Freeform text.
来源：自由格式文本。

Before creating

创建前准备

Gather target project required fields. Common fields:
  1. Title - see guidelines below.
  2. Description - see guidelines below.
  3. Type - Story, Task, Bug, Sub-task, or system equivalent.
  4. Parent - Epic or grouping context; ask if required by target project.
  5. Assignee - assign to self, user, or project default.
  6. Sprint - none (backlog), current, or future.
  7. Priority - Low, Medium, High, or system equivalent.
  8. Metadata - project or system dependent custom fields like Team, Labels.
If details already provided, proceed without asking.
收集目标项目所需的必填字段。常见字段：
  1. 标题 - 请遵循下方指南。
  2. 描述 - 请遵循下方指南。
  3. 类型 - 故事（Story）、任务（Task）、缺陷（Bug）、子任务（Sub-task）或系统等效类型。
  4. 父级 - 史诗（Epic）或分组上下文；若目标项目要求，请询问用户。
  5. 经办人 - 分配给自己、用户或项目默认人员。
  6. 迭代（Sprint） - 无（待办事项）、当前迭代或未来迭代。
  7. 优先级 - 低（Low）、中（Medium）、高（High）或系统等效级别。
  8. 元数据 - 项目或系统相关的自定义字段，如团队、标签。
若已提供详细信息，无需询问即可继续。

Title Guidelines

标题指南

  • Concise
  • Must focus on the goal, not the solution.
  • For features/tasks: imperative mood.
  • For bugs: describe the current state (the issue), not the desired behavior or proposed fix.
  • 简洁明了
  • 必须聚焦目标，而非解决方案。
  • 针对功能/任务：使用祈使语气。
  • 针对缺陷：描述当前状态（问题本身），而非期望行为或提议的修复方案。

Description Guidelines

描述指南

Write structured, developer-friendly descriptions:
  • Tone: Professional, objective, direct.
  • Focus: Focus on the problem and the goal, not the proposed solution. For bugs, describe the issue, not the fix.
  • Details: Sufficient for immediate implementation without extra clarification.
  • Structure:
    • Paragraphs for logical context.
    • Lists for requirements, tasks, or options.
    • Code blocks for logs, code snippets, configs, or command outputs.
    • References or links to files, pull requests, docs, or other tickets.
撰写结构化、便于开发者理解的描述：
  • 语气：专业、客观、直接。
  • 重点：聚焦问题和目标，而非提议的解决方案。针对缺陷，描述问题本身，而非修复方案。
  • 细节：提供足够的信息，无需额外澄清即可直接实施。
  • 结构：
    • 段落用于阐述逻辑上下文。
    • 列表用于列出需求、任务或选项。
    • 代码块用于展示日志、代码片段、配置或命令输出。
    • 引用或链接至文件、拉取请求、文档或其他工单。

Bug Description Template

缺陷描述模板

If type is Bug, description MUST include:
  • Pre-conditions: Required system state, environment, user account, or configuration.
  • Steps to Reproduce (STR): Numbered actions triggering the bug.
  • Actual Result (AR): Incorrect behavior with error logs or messages.
  • Expected Result (ER): Correct expected behavior.
若类型为Bug，描述必须包含：
  • 前置条件：所需的系统状态、环境、用户账户或配置。
  • 复现步骤（STR）：触发缺陷的编号操作步骤。
  • 实际结果（AR）：错误行为及错误日志或消息。
  • 预期结果（ER）：正确的期望行为。

Create

创建流程

Once fields are gathered, write the description to a scratch file via 
scratch
:
Skill(skill: "scratch", args: "write ticket-description md")
Pass the returned path as 
<description_file_path>
to 
ticket-tools
. Fold Assignee, Sprint, Priority, and Metadata into 
FIELDS_JSON
, e.g. 
{"assignee": "self", "priority": "High", "labels": ["bug"]}
- omit keys that don't apply:
Skill(skill: "ticket-tools", args: "create <PROJECT_KEY> <TITLE> <description_file_path> [TYPE] [PARENT] [FIELDS_JSON]")
收集完字段后，通过
scratch
技能将描述写入临时文件：
Skill(skill: "scratch", args: "write ticket-description md")
将返回的路径作为
<description_file_path>
传入
ticket-tools
。将经办人、迭代、优先级和元数据整合到
FIELDS_JSON
中，例如
{"assignee": "self", "priority": "High", "labels": ["bug"]}
- 忽略不适用的键：
Skill(skill: "ticket-tools", args: "create <PROJECT_KEY> <TITLE> <description_file_path> [TYPE] [PARENT] [FIELDS_JSON]")

Output

输出

Ticket URL: From 
ticket-tools
工单URL：来自
ticket-tools