Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update issue templates #1368

Merged
merged 21 commits into from
Dec 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Bug report
description: Create a bug report to help us eliminate issues and improve deepmd-kit.
title: "[BUG] _Replace With Suitable Title_"
labels: bug
assignees: []
body:
- type: textarea
id: summary
attributes:
label: Bug summary
description: Please provide a clear and concise description of what the bug is.
placeholder:
value:
validations:
required: true
- type: input
id: version
attributes:
label: DeePMD-kit Version
description: "`dp --version`"
validations:
required: true
- type: input
id: tf-version
attributes:
label: TensorFlow Version
description: "The version will be printed when running DeePMD-kit."
validations:
required: true
- type: dropdown
id: installation-way
attributes:
label: How did you download the software?
options:
- Offline packages
- conda
- docker
- pip
- Built from source
- Others (write below)
validations:
required: true
- type: textarea
id: log
attributes:
label: Input Files, Running Commands, Error Log, etc.
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."
placeholder:
value:
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to Reproduce
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."
placeholder:
value:
validations:
required: true
- type: textarea
id: further
attributes:
label: Further Information, Files, and Links
description: Put any additional information here, attach relevant text or image files and URLs to external sites, e.g. relevant publications
placeholder:
value:
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Request for Help
url: https://github.com/deepmodeling/deepmd-kit/discussions/491
about: If you have a usage question
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Feature request
description: Suggest an idea for this project.
title: "[Feature Request] _Replace with Title_"
labels: enhancement
assignees: []
body:
- type: textarea
id: summary
attributes:
label: Summary
description: "Please provide a brief and concise description of the suggested feature or change"
placeholder:
value:
validations:
required: true
- type: textarea
id: details
attributes:
label: Detailed Description
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."
placeholder:
value:
validations:
required: true
- type: textarea
id: further
attributes:
label: Further Information, Files, and Links
description: Put any additional information here, attach relevant text or image files and URLs to external sites, e.g. relevant publications
placeholder:
value:
validations:
required: false
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/generic-issue.md

This file was deleted.

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/generic-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Generic issue
description: For issues that do not fit any of the other categories.
title: _Replace With a Descriptive Title_
labels: wontfix
assignees: []
body:
- type: textarea
id: summary
attributes:
label: Summary
description: "Please provide a clear and concise description of what the question is."
placeholder:
value:
validations:
required: true
- type: input
id: version
attributes:
label: DeePMD-kit Version
description: "`dp --version`"
validations:
required: true
- type: input
id: tf-version
attributes:
label: TensorFlow Version
description: "The version will be printed when running DeePMD-kit."
validations:
required: true
- type: textarea
id: other-version
attributes:
label: Python Version, CUDA Version, GCC Version, LAMMPS Version, etc
description: "If applicable, specify what platform you are running on."
placeholder:
value:
validations:
required: false
- type: textarea
id: details
attributes:
label: Details
description: "Please explain the issue in detail here."
placeholder:
value:
validations:
required: true
25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/parameters.md

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/parameters.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Parameters
description: Make a suggestion for a change of input parameters or a new output to deepmd-kit.
title: "[Parameters] _Replace With Suitable Title_"
labels: documentation, enhancement
assignees: []
body:
- type: textarea
id: summary
attributes:
label: Summary
description: "Please provide a clear and concise description of what your request is."
placeholder:
value:
validations:
required: true
- type: textarea
id: details
attributes:
label: Detailed Description
description: "Please explain how you would like to see deepmd-kit enhanced. Specify your material system, and exactly what behaviors or properties you are looking for, or 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."
placeholder:
value:
validations:
required: true
- type: textarea
id: further
attributes:
label: Further Information, Files, and Links
description: Put any additional information here, attach relevant text or image files and URLs to external sites, e.g. relevant publications
placeholder:
value:
validations:
required: false
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/request-for-help.md

This file was deleted.