From 5f0b3ee5719f412d99a52fbbf7fd3e7cb6a2b2e8 Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 13:36:04 -0400 Subject: [PATCH 01/14] Create config.yml --- .github/ISSUE_TEMPLATE/config.yml | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..28cd01497 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Discussions page + url: https://github.com/jacksund/simmate/discussions + about: Ask for help and post about general questions & ideas. + - name: API documentation + url: https://jacksund.github.io/simmate/simmate.html + about: The complete documentation. From d9182a67fa294aae30b8e0514d467676177963d1 Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 13:51:52 -0400 Subject: [PATCH 02/14] Update and rename bug_report.md to 1-bug_report.md --- .github/ISSUE_TEMPLATE/1-bug_report.md | 69 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 44 ---------------- 2 files changed, 69 insertions(+), 44 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1-bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.md b/.github/ISSUE_TEMPLATE/1-bug_report.md new file mode 100644 index 000000000..737c43030 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug_report.md @@ -0,0 +1,69 @@ +# docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema + +name: Bug report +description: Report any errors or problems with your example test case and/or full error messages. +labels: 'bug' +body: + + + - type: markdown + attributes: + value: " + +**PLEASE READ THIS PARAGRAPH - this helps us identify the root cause and fix the issue:** + +If you have a question about getting started or how a feature works, please report your question via our [Discussions Page](https://github.com/jacksund/simmate/discussions/categories/q-a). In many cases, an error message corresponds to using Simmate incorrectly rather than a bug. If you're unsure, stick to a discussion post. We'll then investigate any issues and open a bug report when necessary. + +If you indeed have a bug, it helps to include things like the structure you used, the code, & input files while completing this form. For the code, try not to add long scripts if the error is only happening in one small part of it. Instead, try to generate your issue/error with as little code as possible or even using a illustrative example. + +" + + + - type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + + + - type: textarea + attributes: + label: To Reproduce + description: " +Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example here. + placeholder: "# Insert code here" + + + - type: textarea + attributes: + label: Error + description: "Provide the full error message, including the full exception traceback -- even if it's big and scary." + placeholder: "# Copy complete stack trace and error message here, including log output if applicable." + value: "\ +``` python +# Copy complete error message here. +# Note, the "python" above lets you render with python coloring. +# You can also use coloring for "bash", "yaml", etc. depending on where your error came from. +``` +" + + - type: textarea + attributes: + label: Versions + value: | + - Operating System: + - Python version: + - Simmate version: + + + - type: textarea + attributes: + label: Additional details + description: Add any other context about the problem here. If you have a suggested fix, you can include it here. + + + - type: markdown + attributes: + value: "**Thank you for using our software and helping us improve it!!**" diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 0b3cf97cc..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: 'bug' -assignees: '' - ---- - -## Describe the bug -A clear and concise description of what the bug is. - - -## To Reproduce -Steps to reproduce the behavior: - -**if the bug is in the web UI** -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**if the bug is in python code** -1. Create the structure file... -``` -# POSCAR - -``` -2. Run the following code: -``` python -from simmate.toolkit import Structure -structure = Structure.from_file(...) - -< write your code example here > -< keep this as short and clear as possible! > -``` - - -## Expected behavior -A clear and concise description of what you expected to happen. - - -## Additional context -Add any other context about the problem here, such as relevant links that make help implement a solution. (optional) From 47e9d2042fecf02439f65a0912adcea01eb82d0c Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 13:55:03 -0400 Subject: [PATCH 03/14] Update 1-bug_report.md --- .github/ISSUE_TEMPLATE/1-bug_report.md | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.md b/.github/ISSUE_TEMPLATE/1-bug_report.md index 737c43030..14147e71b 100644 --- a/.github/ISSUE_TEMPLATE/1-bug_report.md +++ b/.github/ISSUE_TEMPLATE/1-bug_report.md @@ -5,8 +5,6 @@ name: Bug report description: Report any errors or problems with your example test case and/or full error messages. labels: 'bug' body: - - - type: markdown attributes: value: " @@ -18,24 +16,18 @@ If you have a question about getting started or how a feature works, please repo If you indeed have a bug, it helps to include things like the structure you used, the code, & input files while completing this form. For the code, try not to add long scripts if the error is only happening in one small part of it. Instead, try to generate your issue/error with as little code as possible or even using a illustrative example. " - - - type: textarea attributes: label: Describe the bug description: A clear and concise description of what the bug is. validations: required: true - - - type: textarea attributes: label: To Reproduce description: " Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example here. placeholder: "# Insert code here" - - - type: textarea attributes: label: Error @@ -48,7 +40,6 @@ Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/ # You can also use coloring for "bash", "yaml", etc. depending on where your error came from. ``` " - - type: textarea attributes: label: Versions @@ -56,14 +47,10 @@ Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/ - Operating System: - Python version: - Simmate version: - - - type: textarea attributes: label: Additional details description: Add any other context about the problem here. If you have a suggested fix, you can include it here. - - - type: markdown attributes: value: "**Thank you for using our software and helping us improve it!!**" From 4171090546f6c7ba3207093bc54213ce94a307b8 Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 13:58:24 -0400 Subject: [PATCH 04/14] Rename 1-bug_report.md to bug_report.md --- .github/ISSUE_TEMPLATE/{1-bug_report.md => bug_report.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{1-bug_report.md => bug_report.md} (100%) diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md similarity index 100% rename from .github/ISSUE_TEMPLATE/1-bug_report.md rename to .github/ISSUE_TEMPLATE/bug_report.md From 00450bc124b5a113bd373512008bb2ddca0de8ca Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 14:00:32 -0400 Subject: [PATCH 05/14] Update config.yml --- .github/ISSUE_TEMPLATE/config.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 28cd01497..a75e38a4a 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,3 @@ -blank_issues_enabled: true contact_links: - name: Discussions page url: https://github.com/jacksund/simmate/discussions From b2575b574f3d2579c60fa02d144dc8b391116aa3 Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 14:03:16 -0400 Subject: [PATCH 06/14] Update and rename bug_report.md to 1-bug_report.yaml --- .github/ISSUE_TEMPLATE/{bug_report.md => 1-bug_report.yaml} | 6 ++++++ 1 file changed, 6 insertions(+) rename .github/ISSUE_TEMPLATE/{bug_report.md => 1-bug_report.yaml} (99%) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/1-bug_report.yaml similarity index 99% rename from .github/ISSUE_TEMPLATE/bug_report.md rename to .github/ISSUE_TEMPLATE/1-bug_report.yaml index 14147e71b..1d47601d1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yaml @@ -16,18 +16,21 @@ If you have a question about getting started or how a feature works, please repo If you indeed have a bug, it helps to include things like the structure you used, the code, & input files while completing this form. For the code, try not to add long scripts if the error is only happening in one small part of it. Instead, try to generate your issue/error with as little code as possible or even using a illustrative example. " + - type: textarea attributes: label: Describe the bug description: A clear and concise description of what the bug is. validations: required: true + - type: textarea attributes: label: To Reproduce description: " Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example here. placeholder: "# Insert code here" + - type: textarea attributes: label: Error @@ -40,6 +43,7 @@ Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/ # You can also use coloring for "bash", "yaml", etc. depending on where your error came from. ``` " + - type: textarea attributes: label: Versions @@ -47,10 +51,12 @@ Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/ - Operating System: - Python version: - Simmate version: + - type: textarea attributes: label: Additional details description: Add any other context about the problem here. If you have a suggested fix, you can include it here. + - type: markdown attributes: value: "**Thank you for using our software and helping us improve it!!**" From ade19918aa6f2e97055975ae976baaa2a70c3d1f Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 14:05:42 -0400 Subject: [PATCH 07/14] Update 1-bug_report.yaml --- .github/ISSUE_TEMPLATE/1-bug_report.yaml | 34 +++++++++++------------- 1 file changed, 15 insertions(+), 19 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.yaml b/.github/ISSUE_TEMPLATE/1-bug_report.yaml index 1d47601d1..dc16cad05 100644 --- a/.github/ISSUE_TEMPLATE/1-bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yaml @@ -7,15 +7,13 @@ labels: 'bug' body: - type: markdown attributes: - value: " - -**PLEASE READ THIS PARAGRAPH - this helps us identify the root cause and fix the issue:** + value: | -If you have a question about getting started or how a feature works, please report your question via our [Discussions Page](https://github.com/jacksund/simmate/discussions/categories/q-a). In many cases, an error message corresponds to using Simmate incorrectly rather than a bug. If you're unsure, stick to a discussion post. We'll then investigate any issues and open a bug report when necessary. + **PLEASE READ THIS PARAGRAPH - this helps us identify the root cause and fix the issue:** -If you indeed have a bug, it helps to include things like the structure you used, the code, & input files while completing this form. For the code, try not to add long scripts if the error is only happening in one small part of it. Instead, try to generate your issue/error with as little code as possible or even using a illustrative example. + If you have a question about getting started or how a feature works, please report your question via our [Discussions Page](https://github.com/jacksund/simmate/discussions/categories/q-a). In many cases, an error message corresponds to using Simmate incorrectly rather than a bug. If you're unsure, stick to a discussion post. We'll then investigate any issues and open a bug report when necessary. -" + If you indeed have a bug, it helps to include things like the structure you used, the code, & input files while completing this form. For the code, try not to add long scripts if the error is only happening in one small part of it. Instead, try to generate your issue/error with as little code as possible or even using a illustrative example. - type: textarea attributes: @@ -27,22 +25,20 @@ If you indeed have a bug, it helps to include things like the structure you used - type: textarea attributes: label: To Reproduce - description: " -Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example here. - placeholder: "# Insert code here" + description: Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example here. + placeholder: Insert code here - type: textarea attributes: label: Error - description: "Provide the full error message, including the full exception traceback -- even if it's big and scary." - placeholder: "# Copy complete stack trace and error message here, including log output if applicable." - value: "\ -``` python -# Copy complete error message here. -# Note, the "python" above lets you render with python coloring. -# You can also use coloring for "bash", "yaml", etc. depending on where your error came from. -``` -" + description: Provide the full error message, including the full exception traceback. + placeholder: Copy complete stack trace and error message here, including log output if applicable. + value: | + ``` python + # Copy complete error message here. + # Note, the "python" above lets you render with python coloring. + # You can also use coloring for "bash", "yaml", etc. depending on where your error came from. + ``` - type: textarea attributes: @@ -59,4 +55,4 @@ Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/ - type: markdown attributes: - value: "**Thank you for using our software and helping us improve it!!**" + value: Thank you for using our software and helping us improve it!! From 93250b39d10011ded5d1cd909729245f0b68c4a4 Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 14:06:56 -0400 Subject: [PATCH 08/14] Update 1-bug_report.yaml --- .github/ISSUE_TEMPLATE/1-bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.yaml b/.github/ISSUE_TEMPLATE/1-bug_report.yaml index dc16cad05..190a9db99 100644 --- a/.github/ISSUE_TEMPLATE/1-bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yaml @@ -1,7 +1,7 @@ # docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms # https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema -name: Bug report +name: 🐞 Bug report description: Report any errors or problems with your example test case and/or full error messages. labels: 'bug' body: From 123ae0b9a06cb607eb34815abb723ac07c65b680 Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 14:07:58 -0400 Subject: [PATCH 09/14] Update 1-bug_report.yaml --- .github/ISSUE_TEMPLATE/1-bug_report.yaml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.yaml b/.github/ISSUE_TEMPLATE/1-bug_report.yaml index 190a9db99..75a04b38c 100644 --- a/.github/ISSUE_TEMPLATE/1-bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yaml @@ -35,9 +35,7 @@ body: placeholder: Copy complete stack trace and error message here, including log output if applicable. value: | ``` python - # Copy complete error message here. - # Note, the "python" above lets you render with python coloring. - # You can also use coloring for "bash", "yaml", etc. depending on where your error came from. + Copy complete error message here. ``` - type: textarea From 08cc871815b0e19d9bf48115202116a084bf2a89 Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 14:10:47 -0400 Subject: [PATCH 10/14] Update 1-bug_report.yaml --- .github/ISSUE_TEMPLATE/1-bug_report.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.yaml b/.github/ISSUE_TEMPLATE/1-bug_report.yaml index 75a04b38c..088c8d0e3 100644 --- a/.github/ISSUE_TEMPLATE/1-bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yaml @@ -41,6 +41,7 @@ body: - type: textarea attributes: label: Versions + description: If you can access them, input your system info. HINT: you can find python and simmate versions with the command `conda list python` and `conda list simmate` while in your working env. value: | - Operating System: - Python version: From 83f30b55bf47151d62dc83350e268a7d061eb37f Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 14:11:23 -0400 Subject: [PATCH 11/14] Update 1-bug_report.yaml --- .github/ISSUE_TEMPLATE/1-bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.yaml b/.github/ISSUE_TEMPLATE/1-bug_report.yaml index 088c8d0e3..22fbcf9d7 100644 --- a/.github/ISSUE_TEMPLATE/1-bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yaml @@ -41,7 +41,7 @@ body: - type: textarea attributes: label: Versions - description: If you can access them, input your system info. HINT: you can find python and simmate versions with the command `conda list python` and `conda list simmate` while in your working env. + description: "If you can access them, input your system info. HINT: you can find python and simmate versions with the command `conda list python` and `conda list simmate` while in your working env." value: | - Operating System: - Python version: From 818f52a5d2d64ab7496442c4c40249b22feacfc9 Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 14:17:30 -0400 Subject: [PATCH 12/14] Update config.yml --- .github/ISSUE_TEMPLATE/config.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a75e38a4a..28cd01497 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,3 +1,4 @@ +blank_issues_enabled: true contact_links: - name: Discussions page url: https://github.com/jacksund/simmate/discussions From 3effa6beaadd472323f776272fd73bb8c3224e9b Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 14:26:44 -0400 Subject: [PATCH 13/14] Update and rename feature_request.md to 2-feature_request.yaml --- .github/ISSUE_TEMPLATE/2-feature_request.yaml | 31 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 -------------- 2 files changed, 31 insertions(+), 24 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/2-feature_request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.yaml b/.github/ISSUE_TEMPLATE/2-feature_request.yaml new file mode 100644 index 000000000..cbc5f87f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature_request.yaml @@ -0,0 +1,31 @@ +# docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema + +name: ⭐ New feature request +description: Propose a new feature or an enhancement +labels: 'enhancement' +body: + + - type: textarea + attributes: + label: Describe the desired feature + description: A clear and concise description of what new feature or behavior you would like to see + + - type: textarea + attributes: + label: Current behavior and/or alternatives + description: A clear and concise description of any alternative solutions or features you have considered. How would you currently do this? + + - type: textarea + attributes: + label: Example Use + description: Provide an example or description of how this would help users. + + - type: textarea + attributes: + label: Additional context + description: Provide additional context about the use case here. + + - type: markdown + attributes: + value: Thank you for using our software and helping us improve it!! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 977c4bbc5..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. An example of code use if helpful: -``` python -# insert custom code that illustrates the new feature -structure.get_my_new_feature(...) -``` - -**Describe alternatives you've considered** -(optional) A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. From 725186a688842e2ed4e055f66eea7c3163dfa66d Mon Sep 17 00:00:00 2001 From: Jack Sundberg Date: Wed, 3 Aug 2022 14:30:07 -0400 Subject: [PATCH 14/14] Create pull_request_template.md --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..639d78941 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1 @@ +Thank you for opening a pull request! Be sure to link this PR to any issues that it fixes.