Skip to content

Commit f1376ee

Browse files
update issue templates (#1368)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent e05873e commit f1376ee

File tree

9 files changed

+143
-129
lines changed

9 files changed

+143
-129
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 37 deletions
This file was deleted.
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
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: DP-GEN Version
20+
description: "`dpgen --version`"
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: other-version
25+
attributes:
26+
label: Platform, Python Version, Remote Platform, etc
27+
description: "If applicable, specify what platform you are running on."
28+
placeholder:
29+
value:
30+
validations:
31+
required: false
32+
- type: textarea
33+
id: log
34+
attributes:
35+
label: Input Files, Running Commands, Error Log, etc.
36+
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."
37+
placeholder:
38+
value:
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: reproduce
43+
attributes:
44+
label: Steps to Reproduce
45+
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."
46+
placeholder:
47+
value:
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: further
52+
attributes:
53+
label: Further Information, Files, and Links
54+
description: Put any additional information here, attach relevant text or image files and URLs to external sites, e.g. relevant publications
55+
placeholder:
56+
value:
57+
validations:
58+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Submit DeePMD-kit issue
4+
url: https://github.com/deepmodeling/deepmd-kit/issues
5+
about: If the issue is related to DeePMD-kit (model training and inference), submit to deepmd-kit repository
6+
- name: Submit dpdata issue
7+
url: https://github.com/deepmodeling/dpdata/issues
8+
about: If the issue is related to dpdata (format conversion), submit to dpdata repository
9+
- name: Submit dpdispatcher issue
10+
url: https://github.com/deepmodeling/dpdispatcher/issues
11+
about: If the issue is related to dpdispatcher (job submission), submit to dpdispatcher repository
12+
- name: Request for Help
13+
url: https://github.com/deepmodeling/dpgen/discussions/new?category=q-a
14+
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 & 25 deletions
This file was deleted.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Generic issue
2+
description: For issues that do not fit any of the other categories.
3+
assignees: []
4+
body:
5+
- type: textarea
6+
id: summary
7+
attributes:
8+
label: Summary
9+
description: "Please provide a clear and concise description of what the question is."
10+
placeholder:
11+
value:
12+
validations:
13+
required: true
14+
- type: input
15+
id: version
16+
attributes:
17+
label: DP-GEN Version
18+
description: "`dpgen --version`"
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: other-version
23+
attributes:
24+
label: Platform, Python Version, etc
25+
description: "If applicable, specify what platform you are running on."
26+
placeholder:
27+
value:
28+
validations:
29+
required: false
30+
- type: textarea
31+
id: details
32+
attributes:
33+
label: Details
34+
description: "Please explain the issue in detail here."
35+
placeholder:
36+
value:
37+
validations:
38+
required: true

.github/ISSUE_TEMPLATE/parameters.md

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

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

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

0 commit comments

Comments
 (0)