backlog

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Backlog

待办积压项(Backlog)

Manages deferred work items as GitHub Issues. Use this whenever work is identified but can't be done yet — blocked by another feature, out of scope for the current PR, or deferred by design.
将延迟的工作项作为GitHub Issue进行管理。当识别到某项工作但目前无法开展时即可使用本工具——比如被其他功能阻塞、超出当前PR的范围,或是按设计需要延迟处理。

Commands

命令

/backlog add <description>

/backlog add <description>

Create a new backlog issue.
  1. Determine the title — short, imperative (e.g., "Add .options() and .env() to createTestService")
  2. Determine what blocks it — another feature, a design decision, a package change, etc.
  3. Create a GitHub Issue using
    gh issue create
    with:
    • Label:
      backlog
    • Label:
      blocked
      (if there's a known blocker)
    • Body format:
markdown
undefined
创建一个新的待办积压项Issue。
  1. 确定标题——简洁、祈使语气(例如:"Add .options() and .env() to createTestService")
  2. 确定阻塞因素——其他功能、设计决策、包变更等
  3. 使用
    gh issue create
    创建GitHub Issue,包含:
    • 标签:
      backlog
    • 标签:
      blocked
      (如果存在已知阻塞因素)
    • 正文格式:
markdown
undefined

What

工作内容

<1-2 sentences describing the deferred work>
<用1-2句话描述延迟的工作内容>

Blocked by

阻塞原因

<What needs to happen first. Reference issues/PRs if applicable, or describe the prerequisite.>
  • <blocker 1>
  • <blocker 2> (if multiple)
<需要先完成的事项。如有适用的Issue/PR请引用,或描述前置条件。>
  • <阻塞项1>
  • <阻塞项2>(如有多个)

Context

上下文信息

<Where this came up — PR number, conversation context, or design doc reference>

4. Print the issue URL when done.
<该项工作的提出场景——PR编号、对话上下文或设计文档引用>

4. 完成后打印Issue的URL。

/backlog list

/backlog list

List open backlog items.
bash
gh issue list --label backlog --state open
Show the results grouped by blocked/unblocked:
  • Blocked — issues that also have the
    blocked
    label
  • Ready — issues with
    backlog
    label but NOT
    blocked
列出所有开放的待办积压项。
bash
gh issue list --label backlog --state open
按“已阻塞/未阻塞”分组显示结果:
  • 已阻塞——同时带有
    blocked
    标签的Issue
  • 可开展——带有
    backlog
    标签但没有
    blocked
    标签的Issue

/backlog unblock <issue-number>

/backlog unblock <issue-number>

Remove the
blocked
label from an issue when its prerequisite is done.
bash
gh issue edit <number> --remove-label blocked
当前置条件完成后,移除Issue的
blocked
标签。
bash
gh issue edit <number> --remove-label blocked

/backlog close <issue-number>

/backlog close <issue-number>

Close a backlog item when it's been implemented.
bash
gh issue close <number>
当待办积压项已实现时,关闭该Issue。
bash
gh issue close <number>

When to Use

使用场景

  • During PR review: When a reviewer or agent flags a missing feature that's out of scope
  • During implementation: When you discover work that depends on something not yet built
  • During planning: When a phase is deferred or descoped
  • After merging: When unblocking a prerequisite, run
    /backlog list
    to check if anything is now ready
  • **PR评审期间:**当评审人员或Agent指出某项缺失功能超出当前PR范围时
  • **开发实现期间:**当你发现某项工作依赖于尚未完成的内容时
  • **规划阶段:**当某一阶段的工作被延迟或缩减范围时
  • **合并PR后:**当解除某项前置条件的阻塞时,运行
    /backlog list
    检查是否有工作项现在可以开展

Labels

标签

Ensure these labels exist in the repo (create them if they don't):
  • backlog
    — deferred work item
  • blocked
    — waiting on a prerequisite
确保仓库中存在以下标签(如果不存在请创建):
  • backlog
    ——延迟的工作项
  • blocked
    ——等待前置条件完成的工作项

Rules

规则

  • Every deferred item MUST have a backlog issue — don't just mention it in a PR comment and forget
  • Always include what blocks the work — "blocked by X" is required context
  • Keep titles actionable — "Add X to Y" not "X is missing"
  • Reference the PR or conversation where the item was identified
  • 每一项延迟的工作项都必须创建对应的待办积压项Issue——不要仅在PR评论中提及就忘记处理
  • 务必包含阻塞该项工作的因素——“被X阻塞”是必要的上下文信息
  • 标题要具备可执行性——比如“为Y添加X”而不是“X缺失”
  • 引用该项工作被提出的PR或对话场景