Back to Details

create-github-issue

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Create a GitHub Issue (
/olissue
)

创建GitHub Issue（
/olissue
）

When the user runs 
/olissue
, guide them through creating a GitHub issue in a 
mitodl
repository using the org's standard issue templates.
当用户运行
/olissue
时，引导他们使用mitodl组织的标准问题模板在
mitodl
仓库中创建GitHub Issue。

Default organization

默认组织

Always default to 
mitodl
 unless the user explicitly names a different org.
除非用户明确指定其他组织，否则始终默认使用**
mitodl
**。

Step 1 — Gather required inputs

步骤1 — 收集必要输入

Ask the user (or infer from context) for:
FieldNotes
Repositorye.g. 
ol-django
— org is implied as 
mitodl
Issue typeSee template menu below
TitleShort, imperative sentence
Body detailsSpecifics to fill into the chosen template
If any field is missing, ask before proceeding.
向用户询问（或从上下文推断）以下信息：
字段说明
仓库例如
ol-django
— 组织默认为
mitodl
问题类型见下方模板菜单
标题简短的祈使句
正文详情填入所选模板的具体内容
若有任何字段缺失，需先询问用户再继续。

Step 2 — Choose a template

步骤2 — 选择模板

Present these four options and apply the matching template body:
#NameLabelsTemplate file
1Bug Report
bug
bug.md
2Technical Issue(none)default.md
3Product Issue(none)product.md
4Design QA
design QA
designQA.md
提供以下四个选项，并应用匹配的模板正文：
#名称标签模板文件
1Bug报告
bug
bug.md
2技术问题无default.md
3产品问题无product.md
4设计QA
design QA
designQA.md

Step 3 — Create the issue

步骤3 — 创建Issue

Use the GitHub CLI to create the issue:
bash
gh issue create \
  --repo mitodl/<repo> \
  --title "<title>" \
  --body "<filled-in template body>" \
  --label "<label>"   # omit if no label for this template type
Confirm the URL returned by 
gh issue create
and share it with the user.
使用GitHub CLI创建Issue：
bash
gh issue create \
  --repo mitodl/<repo> \
  --title "<title>" \
  --body "<filled-in template body>" \
  --label "<label>"   # 若该模板类型无标签则省略
确认
gh issue create
返回的URL并分享给用户。

Template: Bug Report

模板：Bug报告

Labels: 
bug
markdown
<!--- Provide a general summary of the issue in the Title above -->
标签：
bug
markdown
<!--- 在上方标题中提供问题的概述 -->

Expected Behavior

预期行为

<!--- Explain what should happen -->
<!--- 说明应该发生什么 -->

Current Behavior

当前行为

<!--- Describe what happens instead of the expected behavior -->
<!--- 描述实际发生的情况，而非预期行为 -->

Steps to Reproduce

复现步骤

<!--- Provide a link to a live example, or an unambiguous set of steps to --> <!--- reproduce this bug. Include code to reproduce, if relevant -->
<!--- 提供在线示例链接，或明确的复现步骤 --> <!--- 若相关，包含用于复现的代码 -->

Possible Solution

可能的解决方案

<!--- optional — delete if empty --> <!--- Do you have any ideas how to fix this bug? -->
<!--- 可选 — 为空则删除 --> <!--- 你有修复该Bug的思路吗？ -->

Additional Details

额外详情

<!--- optional — delete if empty --> <!--- If there are additional details that are helpful for addressing this bug please add them here --> 

---
<!--- 可选 — 为空则删除 --> <!--- 若有有助于解决该Bug的额外详情，请在此添加 --> 

---

Template: Technical Issue

模板：技术问题

Labels: (none)
markdown
undefined
标签：无
markdown
undefined

Description/Context

描述/背景

<!-- What needs to be done? What additional details are needed by the person who will do the work? -->
<!-- 需要完成什么工作？执行工作的人员需要哪些额外详情？ -->

Plan/Design

计划/设计

<!--- How do you plan to achieve the stated goals? ---> <!--- Include any design documents or visual mockups as relevant ---> 

---
<!--- 你打算如何实现既定目标？ ---> <!--- 若相关，包含设计文档或视觉原型 --> 

---

Template: Product Issue

模板：产品问题

Labels: (none)
markdown
undefined
标签：无
markdown
undefined

User Story

用户故事

<!-- Why does this need to be done? Who will it benefit and how? -->
  • As a ..., I want to ..., so I can ...
<!-- 为什么需要做这件事？谁会从中受益，如何受益？ -->
  • 作为一名...，我想要...，这样我就能...

Description/Context

描述/背景

<!-- What needs to be done? What additional details are needed by the person who will do the work? -->
<!-- 需要完成什么工作？执行工作的人员需要哪些额外详情？ -->

Acceptance Criteria

验收标准

<!-- What are the concrete outcomes that need to happen for this to be "done"? -->
  • [ ]
<!-- 完成这项工作需要达成哪些具体结果？ -->
  • [ ]

Plan/Design

计划/设计

<!--- How do you plan to achieve the stated goals? ---> <!--- Include any design documents or visual mockups as relevant ---> 

---
<!--- 你打算如何实现既定目标？ ---> <!--- 若相关，包含设计文档或视觉原型 --> 

---

Template: Design QA

模板：设计QA

Labels: 
design QA
markdown
<!--- Title template: "Design QA: <Template/Section/Component> -->
标签：
design QA
markdown
<!--- 标题模板："Design QA: <模板/板块/组件> -->

Relevant Links

相关链接

<!--- Include Figma and/or relevant reference links -->
<!--- 包含Figma及其他相关参考链接 -->

Prioritized List of Issues

优先级问题列表

<!--- Provide a prioritized checklist of design feedback with relevant screenshots and details. Include indication of high, med, low priority from a design perspective --> 
  1. high
  2. high
  3. med
  4. low
<!--- 提供按优先级排序的设计反馈清单，包含相关截图和详情。从设计角度标注高、中、低优先级 --> 
  1. high
  2. high
  3. med
  4. low

Additional Details

额外详情

<!--- optional — delete if empty --> <!--- If there are additional details that are helpful for addressing the design feedback please add them here --> 

---
<!--- 可选 — 为空则删除 --> <!--- 若有有助于处理设计反馈的额外详情，请在此添加 --> 

---

Tips

提示

  • Fill in the template sections with the user's details before calling 
    gh issue create
    . Populated templates are more useful than placeholder text.
  • Strip HTML comments (
    <!-- ... -->
    ) from the final body to keep the issue clean.
  • If the user provides a full 
    org/repo
    slug, use it as-is instead of prepending 
    mitodl/
    .
  • For Design QA issues, remind the user to follow the title convention: 
    Design QA: <Template/Section/Component>
    .
  • 在调用
    gh issue create
    之前，先用用户提供的信息填好模板各部分内容。已填充的模板比占位符文本更有用。
  • 从最终正文中移除HTML注释（
    <!-- ... -->
    ），保持Issue内容整洁。
  • 若用户提供完整的
    org/repo
    格式，直接使用该格式，无需添加
    mitodl/
    前缀。
  • 对于设计QA类型的Issue，提醒用户遵循标题约定：
    Design QA: <模板/板块/组件>
    。