Skip to content

Latest commit

 

History

History
95 lines (51 loc) · 4.38 KB

SUBMITTING_AN_ISSUE.zh-cn.md

File metadata and controls

95 lines (51 loc) · 4.38 KB

如何高质量地提交 Issue


概况

​ 在提交 BUG 时需要注意几点,请提供这些详细信息,方便我们准确地评估你问题的严重性,并更快速地诊断其原因。

​ 如果你希望提交功能申请,请创建一个 Issue 并给它添加 feature 标签。代码库中存在名为feature request的项目,请将你的 Issue 分配至feature request项目中。

基本信息

  • 请添加 escape 标签至问题中,方便我们跟踪BUG报告的来源。
  • 请添加一个 feature 标签至功能请求问题中。
  • 提供重现问题的步骤,如果问题可重现。在创建 Issue 后时,会有 "Steps to Reproduce" 的字段,请将步骤填写其中。如果你可以提供重现问题的步骤(即任何人都可以通过该步骤重现问题),就不需要再提供其他任何信息了!”
    • 请详细说明你重现该BUG的环境,是Education还是你的本地环境?如果是你的本地环境中,你运行的是哪一个发行版?如果你是运行我们的主分支,那建议你告诉我们你最近一次更新代码库的日期。
  • 预期行为VS实际行为:你的系统行为是如何的?你对系统在此情况下的预期行为又是怎样的?
  • 商业价值声明:此BUG对我们产品的价值造成怎么样的影响?
  • 方便更加清晰地描述问题,你也可以提供截图。
  • 在Ticket标题中反映BUG的行为,但是,除非BUG是课程相关的,否则切勿在标题中透露课程详细信息。

如果该问题是课程相关的,那么你无法在新课程中重现该问题。则请提供以下信息:

  • 发生问题的页面URL,或课程的URL(至少要有课程URL)
  • 如果该问题比较具体,请提供该章/节/单元的ID。
  • 浏览器中运行的javascript代码也会产生一些问题,如果你在浏览器中的javascript控制台中看到类似error的信息,也可以提供该信息。

重要问题

  • 这是直播课程吗?
  • 目标客户群体是谁?
  • 该问题影响多少用户?该问题是否与课程相关?提供你尽可能准确地猜测此两个问题的答案即可。
  • 你是否觉得该问题造成数据丢失?数据丢失意味着该问题无法自动修复,而且可能会需要重新获取数据,比如学员需要重新提交问题答案。

详细说明

搜索现存Issue

​ 你发现的BUG可能已经被他人提交,在页面右上方的搜索框中输入与该问题相关的文本来搜索。在搜索结果页面,你可以选择搜索参数“标签:xxx”以达到更精细的搜索效果。

​ 如果该问题已被其他人反馈了,你应该在该Issue中留言自己也遇到同样的问题。请勿创建同样的Issue,即便创建了也会被当成重复Issue而删除掉。

新建Issue

​ 当你已确认不存在该问题的反馈报告后,你可以创建一个新的Issue

完成并确认

​ 你可以随时对Issue内容进行更新

​ education的开源团队会分析你的 Issue,他们可能会向你询问关于 Issue 的疑问或其他信息。如果education团队无法 重现你的BUG,则无法修复该BUG,所以强烈建议你在BUG反馈中阐明重现步骤!

解决BUG

​ education不向运行education软件的组织提供正式支持服务,我们希望得知你在使用软件时遇到的BUG和问题,我们只能尽最大努力修复你提出的BUG(因为这些BUG可能也会影响education),但是我们不承诺百分百解决问题。


BUG模板

我们修BUG的动力

​ 一些信息对于我们分析BUG是非常重要的,所以当你在填写Ticket时,请在我们提供的模板中输入该信息。

模板:

## 重现步骤

## 预期行为

## 实际行为

## 显示该error的页面链接

## 商业价值/影响

该BUG对我们产品的价值造成什么样的影响?

## 其他信息

“重现步骤”注意:

​ 如果可以的话,希望你可以在测试课程中重现该BUG(在edge浏览器新建一门课,然后尝试重现该BUG),如果无法重现也不要紧,不过建议你提供相关帮助信息,以便其他人也能看到该BUG。如果还是不行,则请尽可能多地提供信息,但你需要明了地说明该BUG是无法重现的。