Back to Details

new-issue

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

new-issue

新建问题文档

Creates a properly numbered, bilingual issue document for tracking a unit of work.
创建一个编号规范的双语问题文档，用于追踪单项工作任务。

When to Use

使用场景

  • User says "create an issue", "new issue", "start an issue", "이슈 만들기"
  • Beginning a new feature, bug fix, investigation, or task
  • User describes work that should be formally tracked
  • 用户说出“create an issue”、“new issue”、“start an issue”、“이슈 만들기”
  • 开始新功能开发、bug修复、调研或任务时
  • 用户描述了需要正式追踪的工作内容

Step-by-Step Instructions

分步操作指南

Step 1: Determine the Next Issue Number

步骤1：确定下一个问题编号

Check what issue numbers already exist:
bash
ls docs/issue/ 2>/dev/null | grep -E '^issue[0-9]+\.md$' | sort
Take the highest number found and add 1. If no issues exist yet, start at 
001
. Format as zero-padded 3 digits: 
001
, 
002
, ..., 
099
, 
100
, 
101
, ...
查看已存在的问题编号：
bash
ls docs/issue/ 2>/dev/null | grep -E '^issue[0-9]+\.md$' | sort
找到当前最大的编号并加1。如果还没有任何问题文档，则从
001
开始。格式为3位补零数字：
001
、
002
……
099
、
100
、
101
……

Step 2: Gather Issue Details

步骤2：收集问题详情

If the user has already described the work in their message, draft the issue content from that description and ask for confirmation before writing.
Otherwise, ask the user for:
  1. Title — one-line summary of the work
  2. Background — why is this needed? what problem does it solve?
  3. Acceptance Criteria — what does "done" look like?
  4. Initial Tasks — what are the first known steps?
如果用户已经在消息中描述了工作内容，根据该描述草拟问题文档内容，并在写入前请求用户确认。
否则，向用户询问以下信息：
  1. 标题 —— 工作内容的一行摘要
  2. 背景 —— 为什么需要这项工作？它解决什么问题？
  3. 验收标准 —— 怎样才算完成？
  4. 初始任务 —— 已知的第一步工作有哪些？

Step 3: Create the English Issue Document

步骤3：创建英文问题文档

Create 
docs/issue/issue<NNN>.md
:
markdown
undefined
创建
docs/issue/issue<NNN>.md
文件：
markdown
undefined

Issue <NNN>: <Title>

Issue <NNN>: <Title>

Status: Open Created: <YYYY-MM-DD>
Status: Open Created: <YYYY-MM-DD>

Background

Background

<Why this work is needed and what problem it solves>
<Why this work is needed and what problem it solves>

Acceptance Criteria

Acceptance Criteria

  • <Criterion 1>
  • <Criterion 2>
  • <Criterion 1>
  • <Criterion 2>

Tasks

Tasks

  • 1. <Task 1>
  • 2. <Task 2>
  • 1. <Task 1>
  • 2. <Task 2>

Notes

Notes

<!-- Record decisions, discoveries, and blockers here as work progresses --> 

See `references/issue-template.md` for the raw template.
<!-- Record decisions, discoveries, and blockers here as work progresses --> 

原始模板可参考`references/issue-template.md`。

Step 4: Create the Korean Mirror

步骤4：创建韩语镜像文档

Create 
docs/dev/issue/issue<NNN>.ko.md
with the same structure in Korean. Code blocks, file paths, commands, and technical identifiers remain in English.
markdown
undefined
在
docs/dev/issue/issue<NNN>.ko.md
中创建结构相同的韩语版本。代码块、文件路径、命令和技术标识符保留英文。
markdown
undefined

이슈 <NNN>: <한국어 제목>

이슈 <NNN>: <한국어 제목>

상태: 열림 생성일: <YYYY-MM-DD>
상태: 열림 생성일: <YYYY-MM-DD>

배경

배경

<이 작업이 필요한 이유와 해결하려는 문제>
<이 작업이 필요한 이유와 해결하려는 문제>

완료 기준

완료 기준

  • <기준 1>
  • <기준 2>
  • <기준 1>
  • <기준 2>

작업 목록

작업 목록

  • 1. <작업 1>
  • 2. <작업 2>
  • 1. <작업 1>
  • 2. <작업 2>

참고 사항

참고 사항

<!-- 작업 진행 중 결정 사항, 발견 사항, 차단 사항을 여기에 기록하세요 --> 
undefined
<!-- 작업 진행 중 결정 사항, 발견 사항, 차단 사항을 여기에 기록하세요 --> 
undefined

Step 5: Confirm and Report

步骤5：确认并反馈

Tell the user:
Created:
  • docs/issue/issue<NNN>.md
  • docs/dev/issue/issue<NNN>.ko.md
Reference this issue in commit messages with 
Refs: issue<NNN>
.
告知用户：
已创建以下文档：
  • docs/issue/issue<NNN>.md
  • docs/dev/issue/issue<NNN>.ko.md
在提交信息中使用
Refs: issue<NNN>
来关联此问题文档。

Updating Issues During Work

工作过程中更新问题文档

As work progresses, keep the issue document current:
  • Check off completed tasks: 
    - [x] 1. Task 1
  • Update Status from 
    Open
    → 
    In Progress
    → 
    Done
  • Record key decisions in the Notes section
  • Update the Korean mirror when significant changes are made
随着工作推进，保持问题文档内容最新：
  • 勾选已完成的任务：
    - [x] 1. Task 1
  • 将状态从
    Open
    更新为
    In Progress
    再到
    Done
  • 在Notes部分记录关键决策
  • 当内容有重大变更时，同步更新韩语镜像文档