Skip to content

Commit 80b2add

Browse files
author
Ye Ding
authored
Add issue templates for feature request and bug-report (#83)
1 parent 2690192 commit 80b2add

File tree

4 files changed

+174
-0
lines changed

4 files changed

+174
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Bug report
2+
description: Create a bug report to help us eliminate issues and improve deepmd-kit.
3+
title: "[BUG] _Replace With Suitable Title_"
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: DMFF Version
20+
description: Version of DMFF you are using.
21+
validations:
22+
required: true
23+
- type: input
24+
id: jax-version
25+
attributes:
26+
label: JAX Version
27+
description: Version of JAX you are using.
28+
validations:
29+
required: true
30+
- type: input
31+
id: openmm-version
32+
attributes:
33+
label: OpenMM Version
34+
description: Version of OpenMM you are using.
35+
validations:
36+
required: true
37+
- type: dropdown
38+
id: installation-way
39+
attributes:
40+
label: How did you download the software?
41+
options:
42+
- pip
43+
- Built from source
44+
- Others (write below)
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: log
49+
attributes:
50+
label: Input Files, Running Commands, Error Log, etc.
51+
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."
52+
placeholder:
53+
value:
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: reproduce
58+
attributes:
59+
label: Steps to Reproduce
60+
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."
61+
placeholder:
62+
value:
63+
validations:
64+
required: true
65+
- type: textarea
66+
id: further
67+
attributes:
68+
label: Further Information, Files, and Links
69+
description: Put any additional information here, attach relevant text or image files and URLs to external sites, e.g. relevant publications
70+
placeholder:
71+
value:
72+
validations:
73+
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/DMFF/issues
5+
about: If you have a usage question

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Feature request
2+
description: Suggest an idea for DMFF.
3+
title: "[Feature Request] _Replace with Title_"
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: motivation
18+
attributes:
19+
label: Motivation
20+
description: "Please explain why you think this feature is important and should be implemented. 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: solutions
27+
attributes:
28+
label: Suggested Solutions
29+
description: "Please describe possible solutions to the problem. If you have a specific idea in mind, please describe it here. If you don't have a specific idea, please describe what you think would be a good solution to the problem."
30+
placeholder:
31+
value:
32+
validations:
33+
required: false
34+
- type: textarea
35+
id: further
36+
attributes:
37+
label: Further Information, Files, and Links
38+
description: Put any additional information here, attach relevant text or image files and URLs to external sites, e.g. relevant publications. If you have any further questions, please don't hesitate to ask them here.
39+
placeholder:
40+
value:
41+
validations:
42+
required: false

‎.github/ISSUE_TEMPLATE/generic-issue.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Generic issue
2+
description: For issues that do not fit any of the other categories.
3+
title: _Replace With a Descriptive Title_
4+
labels: wontfix
5+
assignees: []
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: Summary
11+
description: "Please provide a clear and concise description of what the question is."
12+
placeholder:
13+
value:
14+
validations:
15+
required: true
16+
- type: input
17+
id: version
18+
attributes:
19+
label: DMFF Version
20+
description: Version of DMFF you are using.
21+
validations:
22+
required: true
23+
- type: input
24+
id: jax-version
25+
attributes:
26+
label: JAX Version
27+
description: Version of JAX you are using.
28+
validations:
29+
required: true
30+
- type: input
31+
id: openmm-version
32+
attributes:
33+
label: OpenMM Version
34+
description: Version of OpenMM you are using.
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: other-version
39+
attributes:
40+
label: Python Version, CUDA Version, GCC Version, Operating System Version etc
41+
description: "If applicable, specify what platform you are running on."
42+
placeholder:
43+
value:
44+
validations:
45+
required: false
46+
- type: textarea
47+
id: details
48+
attributes:
49+
label: Details
50+
description: "Please explain the issue in detail here."
51+
placeholder:
52+
value:
53+
validations:
54+
required: true

0 commit comments

Comments
 (0)