Skip to content

Commit 89b014a

Browse files
authored
Update issue templates
- Revise "Bug Report" - Add "Help Wanted" - Select appropriate tag for each issue template
1 parent 832e783 commit 89b014a

File tree

4 files changed

+44
-7
lines changed

4 files changed

+44
-7
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,33 @@
22
name: Bug Report
33
about: Create a report for problems with ABACUS
44
title: ''
5-
labels: bug
5+
labels: Bug
66
assignees: dyzheng
77

88
---
99

1010
## Describe the Bug
11-
A clear and concise description of what the bug is.
11+
A clear and concise description of what the bug is.
12+
The bug may results in:
13+
- abnormal interruption of the program,
14+
- systematic or randomized numerical error, or
15+
- relatively low efficiency.
16+
17+
## Expected behavior
18+
A clear and concise description of what you expected to happen.
1219

1320
## To Reproduce
1421
Steps to reproduce the behavior:
1522
1. [e.g. clone the source code from ...]
1623
2. [e.g. configure CMake with options ...]
1724
3. [e.g. build ABACUS with ...]
1825
4. [e.g. run ABACUS with ...]
26+
It is recommended to attach your calculation case here for the developers to reproduce the bug.
1927

2028
## Environment
21-
- OS: [e.g. CentOS 7.6]
22-
- Compiler: [e.g. Intel LLVM 2021.1]
23-
- Optional Dependencies: [e.g. Intel MKL]
29+
- OS: [e.g. Ubuntu 20.04]
30+
- Compiler: [e.g. gcc 5.1.0]
31+
- Dependencies: [e.g. Intel MKL, OpenBLAS]
2432

2533
## Additional Context
2634
Add any other context about the problem here.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature Request
3+
about: Suggest something more for ABACUS to do
4+
title: ''
5+
labels: Feature
6+
assignees: mohanchen
7+
8+
---
9+
10+
## Background
11+
A clear and concise description of why this new feature is important.
12+
13+
## Describe the solution you'd like
14+
A clear and concise description of what you want to happen.
15+
16+
## Additional context
17+
Add any other context or screenshots about the feature request here.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Help Wanted
3+
about: For general questions or assistance.
4+
title: ''
5+
labels: Help wanted
6+
assignees: caic99
7+
8+
---
9+
10+
Want to use ABACUS for certain system? Facing problems when installing ABACUS? Don't know how to choose a good parameter? Feel free to reach us, and we'll do our best to help!

.github/ISSUE_TEMPLATE/software-enhancements.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22
name: Software Enhancements
33
about: Suggest an idea to make ABACUS more robust and organized
44
title: ''
5-
labels: enhancement
5+
labels: Refactor
66
assignees: caic99
77

88
---
99

1010
## Describe Current Status and Possible Solution
1111

12-
A clear and concise description of why this enhancement is important. If you have some ideas about how to achieve it, please also describe.
12+
A clear and concise description of why this enhancement is important.
13+
Describing the current situation of ABACUS is preferred.
14+
If you have some ideas about how to achieve it, please feel free to comment.
1315

1416
## Additional Context
1517

0 commit comments

Comments
 (0)