From 65b175a2ff2446b59c7bae164d7610c65e7f23b1 Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Thu, 19 Oct 2023 18:19:51 -0400 Subject: [PATCH 1/2] update issue templates Copied from DeePMD-kit with miror changes, which I think is good enough. --- .github/ISSUE_TEMPLATE/bug_report.md | 25 ----------- .github/ISSUE_TEMPLATE/bug_report.yml | 49 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/feature_request.md | 21 ---------- .github/ISSUE_TEMPLATE/feature_request.yml | 33 +++++++++++++++ .github/ISSUE_TEMPLATE/generic-issue.md | 17 -------- .github/ISSUE_TEMPLATE/generic-issue.yml | 40 ++++++++++++++++++ .github/ISSUE_TEMPLATE/request-for-help.md | 21 ---------- 8 files changed, 127 insertions(+), 84 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/generic-issue.md create mode 100644 .github/ISSUE_TEMPLATE/generic-issue.yml delete mode 100644 .github/ISSUE_TEMPLATE/request-for-help.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index b9591ad05..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Bug report -about: Create a bug report to help us eliminate issues and improve dpdata. If this - doesn’t look right, [choose a different type](https://github.com/deepmodeling/dpdata/issues/new/choose). -title: "[BUG] _Replace With Suitable Title_" -labels: bug -assignees: '' - ---- - -**Summary** - - - - - - - -**Steps to Reproduce** - - - -**Further Information, Files, and Links** - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..f25c32d33 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,49 @@ +name: Bug report +description: Create a bug report to help us eliminate issues and improve deepmd-kit. +title: "[BUG] " +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: dpdata Version + description: "`dpdata --version`" + 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..9c8e4e881 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Request for Help + url: https://github.com/deepmodeling/dpdata/discussions/new?category=q-a + about: If you have an usage question diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 0af5c9534..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project. If this doesn’t work right, [choose a different - type]( https://github.com/deepmodeling/dpdata/issues/new/choose). -title: "[Feature Request] _Replace with Title_" -labels: enhancement -assignees: '' - ---- - -**Summary** - - - -**Detailed Description** - - - -**Further Information, Files, and Links** - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..18781a841 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,33 @@ +name: Feature request +description: Suggest an idea for this project. +title: "[Feature Request] " +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 diff --git a/.github/ISSUE_TEMPLATE/generic-issue.md b/.github/ISSUE_TEMPLATE/generic-issue.md deleted file mode 100644 index 8ae84e1cf..000000000 --- a/.github/ISSUE_TEMPLATE/generic-issue.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Generic issue -about: For issues that do not fit any of the other categories. If this doesn’t work - right, [choose a different type]( https://github.com/deepmodeling/dpdata/issues/new/choose). -title: '' -labels: wontfix -assignees: '' - ---- - -**Summary** - - - -**Details** - - diff --git a/.github/ISSUE_TEMPLATE/generic-issue.yml b/.github/ISSUE_TEMPLATE/generic-issue.yml new file mode 100644 index 000000000..8fdf02ecf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/generic-issue.yml @@ -0,0 +1,40 @@ +name: Generic issue +description: For issues that do not fit any of the other categories. +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: dpdata Version + description: "`dpdata --version`" + validations: + required: true + - type: textarea + id: other-version + attributes: + label: Platform, Python 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 diff --git a/.github/ISSUE_TEMPLATE/request-for-help.md b/.github/ISSUE_TEMPLATE/request-for-help.md deleted file mode 100644 index ad05a34d3..000000000 --- a/.github/ISSUE_TEMPLATE/request-for-help.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Request for Help -about: Don't post help requests here, go to [discussions](https://github.com/deepmodeling/dpdata/discussions) - instead. If this doesn’t look right, choose a different type. -title: '' -labels: '' -assignees: '' - ---- - -Before asking questions, you can - -search the previous issues or discussions -check the [README](https://github.com/deepmodeling/dpdata/#readme). - -Please **do not** post requests for help (e.g. with installing or using dpdata) here. -Instead go to [discussions](https://github.com/deepmodeling/dpdata/discussions). - -This issue tracker is for tracking dpdata development related issues only. - -Thanks for your cooperation. From 81c34faadf910989d3d36a941d7bfd22c5b629d1 Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Thu, 19 Oct 2023 18:21:14 -0400 Subject: [PATCH 2/2] remove title --- .github/ISSUE_TEMPLATE/generic-issue.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/generic-issue.yml b/.github/ISSUE_TEMPLATE/generic-issue.yml index 8fdf02ecf..fbc5bca8e 100644 --- a/.github/ISSUE_TEMPLATE/generic-issue.yml +++ b/.github/ISSUE_TEMPLATE/generic-issue.yml @@ -1,6 +1,5 @@ name: Generic issue description: For issues that do not fit any of the other categories. -title: "" labels: wontfix assignees: [] body: