Back to Details

github-issue

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Github Issue

GitHub Issue

Overview

概述

Create well-scoped GitHub issues using the repo’s Codex issue template and 
gh issue create
. Keep issues detailed enough for a Codex Argo workflow to execute the full request in one run.
使用仓库的Codex问题模板和
gh issue create
命令创建范围明确的GitHub Issue。Issue需足够详细，以便Codex Argo工作流能一次性执行完整请求。

Workflow

工作流程

1) Gather the required details

1) 收集必要信息

  • Ensure you have: summary, context, desired outcome, scope (in/out), constraints/risks, rollout notes, validation, and a Codex prompt.
  • If the user already provided content, reuse it verbatim and only ask for missing fields.
  • 确保你已准备好：摘要、背景信息、预期结果、范围（包含/排除）、约束条件/风险、发布说明、验证方法以及Codex提示词。
  • 如果用户已提供相关内容，直接原文复用，仅询问缺失的字段。

2) Start from the template

2) 从模板开始

  • Use 
    .github/ISSUE_TEMPLATE/codex-task.md
    as the base.
  • Copy it into a temp file and fill in every section. Keep it concise but complete.
  • 以
    .github/ISSUE_TEMPLATE/codex-task.md
    为基础模板。
  • 将其复制到临时文件中，填写所有部分。内容需简洁但完整。

3) Write a precise Codex prompt

3) 编写精准的Codex提示词

  • The prompt should be an explicit, step-by-step plan with exact file paths, constraints, and expected outputs.
  • If multiple fixes are needed, enumerate them and specify validation.
  • Avoid ambiguity; Codex should be able to execute without follow-up.
  • 提示词应是明确的分步计划，包含确切的文件路径、约束条件和预期输出。
  • 如果需要多项修复，逐一列举并指定验证方式。
  • 避免模糊表述；Codex应无需后续跟进即可执行。

4) Create the issue with gh

4) 使用gh创建Issue

bash
cp .github/ISSUE_TEMPLATE/codex-task.md /tmp/issue.md
$EDITOR /tmp/issue.md
gh issue create --title "<clear, scoped title>" --body-file /tmp/issue.md --label codex
bash
cp .github/ISSUE_TEMPLATE/codex-task.md /tmp/issue.md
$EDITOR /tmp/issue.md
gh issue create --title "<clear, scoped title>" --body-file /tmp/issue.md --label codex

5) Report the result

5) 反馈结果

  • Return the issue URL and a short confirmation.
  • If the repo requires extra labels or assignees, add them explicitly.
  • 返回Issue的URL和简短确认信息。
  • 如果仓库需要额外的标签或经办人，需明确添加。

Notes

注意事项

  • Prefer one issue per coherent workstream.
  • When a request spans multiple components, ensure scope boundaries are clear in the template.
  • 每个连贯的工作流优先对应一个Issue。
  • 当请求涉及多个组件时，确保模板中的范围边界清晰。