Skip to content

Commit

Permalink
MISC: update issue template (#2692)
Browse files Browse the repository at this point in the history
* MISC: update issue template

* MISC: fix bugs in issue template
  • Loading branch information
cebarobot committed Feb 19, 2024
1 parent 1fcb3bc commit 13156de
Show file tree
Hide file tree
Showing 7 changed files with 139 additions and 48 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Report a bug (incorrect behaviors) of XiangShan Processor Cores.
title: ''
labels: 'bug report'
assignees: ''

---

#### Before start
PLEASE MAKE SURE you have done these:
- [x] (Select what you have done like this)
- [ ] I have read the [RISC-V ISA Manual](https://github.com/riscv/riscv-isa-manual) and this is not a RISC-V ISA question.
- [ ] I have read the [XiangShan Documents](https://xiangshan-doc.readthedocs.io/zh_CN/latest).
- [ ] I have searched the previous issues and did not find anything relevant.
- [ ] I have reviewed the commit messages from the relevant commit history.

#### Describe the bug
A clear and concise description of what the bug is.

#### Screenshots
If applicable, add screenshots to help explain your problem.

#### Expected behavior
A clear and concise description of what you expected to happen.

#### To Reproduce
Steps to reproduce the bug. Also a corresponding minimal workload (source code and bin) along with a description.

#### Environment (please complete the following information):
- XiangShan branch: [paste branch name here if applicable]
- XiangShan commit id: [paste commit id here if applicable]
- NEMU commit id: [paste commit id here if applicable]
- SPIKE commit id: [paste commit id here if applicable]

#### Additional context
Add any other context about the problem here.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Feature request
about: Suggest an idea for XiangShan project.
title: ''
labels: 'feature request'
assignees: ''

---

#### Before start
PLEASE MAKE SURE you have done these:
- [x] (Select what you have done like this)
- [ ] I have read the [RISC-V ISA Manual](https://github.com/riscv/riscv-isa-manual).
- [ ] I have read the [XiangShan Documents](https://xiangshan-doc.readthedocs.io/zh_CN/latest).
- [ ] I have searched the previous issues and did not find anything relevant.
- [ ] I have reviewed the commit messages from the relevant commit history.

#### Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

#### Describe the solution you'd like
A clear and concise description of what you want.

#### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

#### Additional context
Add any other context or screenshots about the feature request here.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/3-problem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Problem
about: Problem encountered when compiling XiangShan, running EMU, etc.
title: ''
labels: 'problem'
assignees: ''

---

<!-- 您可以使用中文或英文提问,我们推荐使用英文。 -->

#### Before start
PLEASE MAKE SURE you have done these: <!-- 请确保您已经做过以下事情 -->
- [x] (Select what you have done like this) <!-- 像这样选择您已经做过的事情 -->
- [ ] I have read the [XiangShan Documents](https://xiangshan-doc.readthedocs.io/zh_CN/latest). <!-- 我已经阅读过香山文档 -->
- [ ] I just followed the description in the documents. <!-- 我按照文档进行的操作 -->
- [ ] I cannot find solutions in the documents. <!-- 我在文档中找不到解决方案 -->
- [ ] I have searched the previous issues and did not find anything relevant. <!-- 我已经搜索过之前的 issue,并没有找到相关的 -->

#### Describe you problem. <!-- 描述您的问题 -->
A clear and concise description of what the problem is. <!-- 请清晰、准确的描述您遇到的问题 -->

#### Screenshots <!-- 屏幕截图 -->
If applicable, add screenshots to help explain your problem. <!-- 建议您附上遇到问题时的屏幕截图 -->

#### What did you do before <!-- 您在之前都做了哪些操作 -->
Please describe step by step what did you do before you encounted the problem. <!-- 请描述您遇到问题前都做了哪些操作 -->


#### Environment (please complete the following information): <!-- 环境信息,请务必填写清楚 -->
- Operating System: [e.g. Ubuntu 20.04]
- gcc version: [paste first line of the output of `gcc --version` if applicable]
- mill version: [paste first line of the output of `mill -i --version` if applicable]
- java version: [paste first line of the output of `java --version` if applicable]
- XiangShan branch: [paste branch name here if applicable]
- XiangShan commit id: [paste commit id here if applicable]
- NEMU commit id: [paste commit id here if applicable]
- SPIKE commit id: [paste commit id here if applicable]

#### Additional context <!-- 额外信息 -->
Add any other context about the problem here.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/4-other_question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Other Question
about: Any other question about XiangShan.
title: ''
labels: 'question'
assignees: ''

---

<!-- 您可以使用中文或英文提问,我们推荐使用英文。 -->

#### Before start
PLEASE MAKE SURE you have done these: <!-- 请确保您已经做过以下事情 -->
- [x] (Select what you have done like this) <!-- 像这样选择您已经做过的事情 -->
- [ ] I have read the [RISC-V ISA Manual](https://github.com/riscv/riscv-isa-manual) and this is not a RISC-V ISA question. <!-- 我已经阅读过 RISC-V 指令集手册,这不是一个指令集相关的问题 -->
- [ ] I have read the [XiangShan Documents](https://xiangshan-doc.readthedocs.io/zh_CN/latest). <!-- 我已经阅读过香山文档 -->
- [ ] I have searched the previous issues and did not find anything relevant. <!-- 我已经搜索过之前的 issue,并没有找到相关的 -->
- [ ] I have searched the previous discussions and did not find anything relevant. <!-- 我已经搜索过之前的 discussions,并没有找到相关的 -->
- [ ] I have reviewed the commit messages from the relevant commit history. <!-- 我已经查看过相关提交的提交信息 -->

#### Describe the question <!-- 描述您的问题 -->
A clear and concise description of your question.
28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: RISC-V ISA Quesion / Problem
url: https://github.com/riscv/riscv-isa-manual/issues
about: Ask RISC-V ISA questions here.
- name: NEMU Question / Problem
url: https://github.com/OpenXiangShan/NEMU/issues
about: Ask NEMU questions here.
- name: Questions and Discussions
url: https://github.com/OpenXiangShan/XiangShan/discussions
about: Please consider to use Discussions.
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 13156de

Please sign in to comment.