Skip to content

Commit 4f0fe6f

Browse files
author
haozhihan
committed
docs: Change issue templates to issue form
1 parent e4dde18 commit 4f0fe6f

File tree

10 files changed

+181
-96
lines changed

10 files changed

+181
-96
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 0 additions & 34 deletions
This file was deleted.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Bug Report
2+
description: Create a report for problems with ABACUS
3+
labels: Bug
4+
assignees:
5+
- dyzheng
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Describe the bug
10+
description: >
11+
A clear and concise description of what the bug is.
12+
The bug may results in:
13+
14+
- abnormal interruption of the program,
15+
16+
- systematic or randomized numerical error, or
17+
18+
- relatively low efficiency.
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: Expected behavior
25+
description: >
26+
A clear and concise description of what you expected to happen.
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: To Reproduce
32+
description: >
33+
Steps to reproduce the behavior:
34+
35+
1. [e.g. clone the source code from ...]
36+
37+
2. [e.g. configure CMake with options ...]
38+
39+
3. [e.g. build ABACUS with ...]
40+
41+
4. [e.g. run ABACUS with ...]
42+
43+
44+
It is recommended to attach your calculation case here for the developers to reproduce the bug.
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: Environment
50+
description: >
51+
- OS: [e.g. Ubuntu 20.04]
52+
53+
- Compiler: [e.g. gcc 5.1.0]
54+
55+
- Dependencies: [e.g. Intel MKL, OpenBLAS]
56+
validations:
57+
required: true
58+
- type: textarea
59+
attributes:
60+
label: Additional Context
61+
description: >
62+
Add any other context about the problem here.
63+
- type: markdown
64+
attributes:
65+
value: >
66+
Thanks for contributing 🎉!
67+
68+

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Feature Request
2+
description: Suggest something more for ABACUS to do
3+
labels: Feature
4+
assignees:
5+
- mohanchen
6+
7+
body:
8+
- type: textarea
9+
attributes:
10+
label: Background
11+
description: >
12+
A clear and concise description of why this new feature is important.
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
attributes:
18+
label: Describe the solution you'd like
19+
description: >
20+
A clear and concise description of what you want to happen.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
attributes:
26+
label: Additional Context
27+
description: >
28+
Add any other context or screenshots about the feature request here.
29+
30+
- type: markdown
31+
attributes:
32+
value: >
33+
Thanks for contributing 🎉!

.github/ISSUE_TEMPLATE/functionality-request.md

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Functionality Request
2+
description: Suggest something more for ABACUS to do
3+
labels: enhancement
4+
assignees:
5+
- mohanchen
6+
7+
body:
8+
- type: textarea
9+
attributes:
10+
label: Background
11+
description: >
12+
A clear and concise description of why this new feature is important.
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
attributes:
18+
label: Describe the solution you'd like
19+
description: >
20+
A clear and concise description of what you want to happen.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
attributes:
26+
label: Additional Context
27+
description: >
28+
Add any other context or screenshots about the feature request here.
29+
30+
- type: markdown
31+
attributes:
32+
value: >
33+
Thanks for contributing 🎉!

.github/ISSUE_TEMPLATE/help-wanted.md

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Help Wanted
2+
description: For general questions or assistance.
3+
labels: Help wanted
4+
assignees:
5+
- caic99
6+
7+
body:
8+
- type: textarea
9+
attributes:
10+
label: Details
11+
description: >
12+
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!
13+
validations:
14+
required: true
15+
- type: markdown
16+
attributes:
17+
value: >
18+
Thanks for contributing 🎉!

.github/ISSUE_TEMPLATE/software-enhancements.md

Lines changed: 0 additions & 18 deletions
This file was deleted.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Software Enhancements
2+
description: Suggest an idea to make ABACUS more robust and organized
3+
labels: Refactor
4+
assignees:
5+
- caic99
6+
7+
body:
8+
- type: textarea
9+
attributes:
10+
label: Describe Current Status and Possible Solution
11+
description: >
12+
A clear and concise description of why this enhancement is important.
13+
14+
Describing the current situation of ABACUS is preferred.
15+
16+
If you have some ideas about how to achieve it, please feel free to comment.
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
attributes:
22+
label: Additional Context
23+
description: >
24+
Add any other context or screenshots about the enhancement here.
25+
26+
- type: markdown
27+
attributes:
28+
value: >
29+
Thanks for contributing 🎉!

0 commit comments

Comments
 (0)