Skip to content

Commit dbe2bc9

Browse files
authored
update issue templates (#557)
Copied from DeePMD-kit with minor changes, which I think is good enough.
1 parent 3f35ac6 commit dbe2bc9

File tree

8 files changed

+126
-84
lines changed

8 files changed

+126
-84
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Bug report
2+
description: Create a bug report to help us eliminate issues and improve deepmd-kit.
3+
title: "[BUG] "
4+
labels: bug
5+
assignees: []
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: Bug summary
11+
description: Please provide a clear and concise description of what the bug is.
12+
placeholder:
13+
value:
14+
validations:
15+
required: true
16+
- type: input
17+
id: version
18+
attributes:
19+
label: dpdata Version
20+
description: "`dpdata --version`"
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: log
25+
attributes:
26+
label: Input Files, Running Commands, Error Log, etc.
27+
description: "Please provide necessary information including input file, running commands, error log , etc., AS DETAILED AS POSSIBLE to help locate and reproduce your problem. WARNING: Do not use image to show error log! Paste texts in a code block instead."
28+
placeholder:
29+
value:
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: reproduce
34+
attributes:
35+
label: Steps to Reproduce
36+
description: "Describe the steps required to (quickly) reproduce the issue. You can attach (small) files to the section below or add URLs where to download an archive with all necessary files. Please try to create an input set that is as minimal and small as possible and reproduces the bug as quickly as possible. **NOTE:** the less effort and time it takes to reproduce your reported bug, the more likely it becomes, that somebody will look into it and fix the problem."
37+
placeholder:
38+
value:
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: further
43+
attributes:
44+
label: Further Information, Files, and Links
45+
description: Put any additional information here, attach relevant text or image files and URLs to external sites, e.g. relevant publications
46+
placeholder:
47+
value:
48+
validations:
49+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Request for Help
4+
url: https://github.com/deepmodeling/dpdata/discussions/new?category=q-a
5+
about: If you have an usage question

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 21 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 an idea for this project.
3+
title: "[Feature Request] "
4+
labels: enhancement
5+
assignees: []
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: Summary
11+
description: "Please provide a brief and concise description of the suggested feature or change"
12+
placeholder:
13+
value:
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: details
18+
attributes:
19+
label: Detailed Description
20+
description: "Please explain how you would like to see deepmd-kit enhanced, what feature(s) you are looking for, what specific problems this will solve. If possible, provide references to relevant background information like publications or web pages, and whether you are planning to implement the enhancement yourself or would like to participate in the implementation. If applicable add a reference to an existing bug report or issue that this will address."
21+
placeholder:
22+
value:
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: further
27+
attributes:
28+
label: Further Information, Files, and Links
29+
description: Put any additional information here, attach relevant text or image files and URLs to external sites, e.g. relevant publications
30+
placeholder:
31+
value:
32+
validations:
33+
required: false

.github/ISSUE_TEMPLATE/generic-issue.md

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Generic issue
2+
description: For issues that do not fit any of the other categories.
3+
labels: wontfix
4+
assignees: []
5+
body:
6+
- type: textarea
7+
id: summary
8+
attributes:
9+
label: Summary
10+
description: "Please provide a clear and concise description of what the question is."
11+
placeholder:
12+
value:
13+
validations:
14+
required: true
15+
- type: input
16+
id: version
17+
attributes:
18+
label: dpdata Version
19+
description: "`dpdata --version`"
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: other-version
24+
attributes:
25+
label: Platform, Python Version, etc
26+
description: "If applicable, specify what platform you are running on."
27+
placeholder:
28+
value:
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: details
33+
attributes:
34+
label: Details
35+
description: "Please explain the issue in detail here."
36+
placeholder:
37+
value:
38+
validations:
39+
required: true

.github/ISSUE_TEMPLATE/request-for-help.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

0 commit comments

Comments
 (0)