已合并
Docs:add issue&PR template #14
wangzitao创建于 3月12日
Docs:add issue&PR template #14
已合并
共 5 个文件变更+142-0
| @@ -0,0 +1,46 @@ | |||
| 1 | +name: Bug-Report|缺陷反馈 | ||
| 2 | +description: 当您发现了一个缺陷,需要向社区反馈时,请使用此模板。 | ||
| 3 | +title: "[Bug-Report|缺陷反馈]: " | ||
| 4 | +labels: ["bug-report"] | ||
| 5 | +body: | ||
| 6 | + - type: markdown | ||
| 7 | + attributes: | ||
| 8 | + value: | | ||
| 9 | + Thanks for sending an issue! Please fill in the following template to help quickly solve your problem. | ||
| 10 | + - type: textarea | ||
| 11 | + attributes: | ||
| 12 | + label: Describe the current behavior / 问题描述 (Mandatory / 必填) | ||
| 13 | + description: 提供尽可能多的信息描述产生了什么问题 | ||
| 14 | + placeholder: "" | ||
| 15 | + validations: | ||
| 16 | + required: true | ||
| 17 | + - type: textarea | ||
| 18 | + attributes: | ||
| 19 | + label: Environment / 环境信息 (Mandatory / 必填) | ||
| 20 | + description: 请提供昇腾硬件型号与软件环境信息 | ||
| 21 | + validations: | ||
| 22 | + required: true | ||
| 23 | + - type: textarea | ||
| 24 | + attributes: | ||
| 25 | + label: Steps to reproduce the issue / 重现步骤 (Mandatory / 必填) | ||
| 26 | + description: 提供尽可能多的信息描述如何重现该缺陷 | ||
| 27 | + validations: | ||
| 28 | + required: true | ||
| 29 | + - type: textarea | ||
| 30 | + attributes: | ||
| 31 | + label: Describe the expected behavior / 预期结果 (Mandatory / 必填) | ||
| 32 | + description: 描述期望的行为应该是什么样子的 | ||
| 33 | + validations: | ||
| 34 | + required: true | ||
| 35 | + - type: textarea | ||
| 36 | + attributes: | ||
| 37 | + label: Related log / screenshot / 日志 / 截图 (Mandatory / 必填) | ||
| 38 | + description: 提供尽可能多的日志/结果信息 | ||
| 39 | + validations: | ||
| 40 | + required: true | ||
| 41 | + - type: textarea | ||
| 42 | + attributes: | ||
| 43 | + label: Special notes for this issue/备注 (Optional / 选填) | ||
| 44 | + description: 补充下其他您认为需要提供的信息 | ||
| 45 | + validations: | ||
| 46 | + required: false | ||
| @@ -0,0 +1,27 @@ | |||
| 1 | +name: Documentation|文档反馈 | ||
| 2 | +description: 如果您需要反馈文档问题,请使用此模板。 | ||
| 3 | +title: "[Documentation|文档反馈]: " | ||
| 4 | +labels: ["documentation"] | ||
| 5 | +body: | ||
| 6 | + - type: markdown | ||
| 7 | + attributes: | ||
| 8 | + value: | | ||
| 9 | + Thanks for sending an issue! Please fill in the following template to help quickly solve your problem. | ||
| 10 | + - type: textarea | ||
| 11 | + attributes: | ||
| 12 | + label: Document Link(文档链接) | ||
| 13 | + description: 请给出有问题的文档链接 | ||
| 14 | + validations: | ||
| 15 | + required: true | ||
| 16 | + - type: textarea | ||
| 17 | + attributes: | ||
| 18 | + label: Issues Section(问题文档片段) | ||
| 19 | + description: 请给出问题文档片段或截图 | ||
| 20 | + validations: | ||
| 21 | + required: true | ||
| 22 | + - type: textarea | ||
| 23 | + attributes: | ||
| 24 | + label: Existing Issues(存在的问题) | ||
| 25 | + description: 请描述下存在的问题 | ||
| 26 | + validations: | ||
| 27 | + required: false | ||
| @@ -0,0 +1,33 @@ | |||
| 1 | +name: Requirement|需求建议 | ||
| 2 | +description: 您需要反馈或实现一个新需求时,请使用此模板。 | ||
| 3 | +title: "[Requirement|需求建议]: " | ||
| 4 | +labels: ["requirement"] | ||
| 5 | +body: | ||
| 6 | + - type: markdown | ||
| 7 | + attributes: | ||
| 8 | + value: | | ||
| 9 | + Thanks for sending an requirement! Please fill in the following template to help quickly solve your problem. | ||
| 10 | + - type: textarea | ||
| 11 | + attributes: | ||
| 12 | + label: Backgroud(背景信息) | ||
| 13 | + description: 请描述下新需求的功能是什么,解决了什么问题 | ||
| 14 | + validations: | ||
| 15 | + required: true | ||
| 16 | + - type: textarea | ||
| 17 | + attributes: | ||
| 18 | + label: Origin(信息来源) | ||
| 19 | + description: 请说明下是哪个部门/团队提出的需求,以便我们确定优先级 | ||
| 20 | + validations: | ||
| 21 | + required: true | ||
| 22 | + - type: textarea | ||
| 23 | + attributes: | ||
| 24 | + label: Benefit / Necessity (价值/作用) | ||
| 25 | + description: 请描述下该需求的价值,应用场景等 | ||
| 26 | + validations: | ||
| 27 | + required: false | ||
| 28 | + - type: textarea | ||
| 29 | + attributes: | ||
| 30 | + label: Design(设计方案) | ||
| 31 | + description: 请描述/解释设计的总体思路(可以使用伪代码) | ||
| 32 | + validations: | ||
| 33 | + required: false | ||
| @@ -0,0 +1,15 @@ | |||
| 1 | +name: Question|问题咨询 | ||
| 2 | +description: 如果您需要咨询或者讨论问题,请使用此模板。 | ||
| 3 | +title: "[Question|问题咨询]: " | ||
| 4 | +labels: ["question"] | ||
| 5 | +body: | ||
| 6 | + - type: markdown | ||
| 7 | + attributes: | ||
| 8 | + value: | | ||
| 9 | + Welcome to ask questions and discuss with other members. | ||
| 10 | + - type: textarea | ||
| 11 | + attributes: | ||
| 12 | + label: 问题描述 | ||
| 13 | + description: 请描述下您的问题 | ||
| 14 | + validations: | ||
| 15 | + required: true | ||
| @@ -0,0 +1,21 @@ | |||
| 1 | +## 描述 | ||
| 2 | +<!--在这里详细描述你的改动,包括改动的原因和所采取的方法。--> | ||
| 3 | + | ||
| 4 | +## 关联的Issue | ||
| 5 | +<!-- 如果这个PR是为了解决特定的Issue,请在这里提供Issue链接。例如:关联Issue #000--> | ||
| 6 | + | ||
| 7 | +## 测试 | ||
| 8 | +<!--描述进行了哪些测试来验证你的改动。--> | ||
| 9 | + | ||
| 10 | +## 文档更新 | ||
| 11 | +<!--如果这个PR包含文档的更新,请在这里指出。例如:更新了README.md文件。--> | ||
| 12 | + | ||
| 13 | +## 类型标签 | ||
| 14 | +<!-- [x] 表示选中 --> | ||
| 15 | +- [ ] Bug修复 | ||
| 16 | +- [ ] 新特性 | ||
| 17 | +- [ ] 性能优化 | ||
| 18 | +- [ ] 文档更新 | ||
| 19 | +- [ ] 其他,请描述: | ||
| 20 | + | ||
| 21 | + | ||