From 0324350f78a002844892f986df5a783d3a3bd7c8 Mon Sep 17 00:00:00 2001 From: "paul.profizi" Date: Fri, 26 May 2023 12:08:19 +0200 Subject: [PATCH 1/2] Add examples.yml issue template --- .github/ISSUE_TEMPLATE/examples.yml | 75 +++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/examples.yml diff --git a/.github/ISSUE_TEMPLATE/examples.yml b/.github/ISSUE_TEMPLATE/examples.yml new file mode 100644 index 00000000000..6dcbf311309 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/examples.yml @@ -0,0 +1,75 @@ +name: 🎓 Adding an example +description: Proposing a new example for the library +title: "Example proposal: ..." +labels: ["example"] +assignees: [""] + +body: + + - type: textarea + id: example-description + attributes: + label: '📝 Description of the example' + placeholder: Describe what example you devised and why it is useful for the project. + + validations: + required: true + + - type: textarea + id: example-files + attributes: + label: '📁 Files needed for running the example' + placeholder: > + Drag and drop the files used in your example, together with the script employed. + Make sure that it runs on your machine, at the very least. + Add any additional comments/explanations that maintainers may need for running the example. + If you have issues uploading your files because of the file extension/type, upload them + as a .zip file. + validations: + required: true + + - type: dropdown + id: os-name + attributes: + label: '💻 Which operating system are you using?' + multiple: false + options: + - 'Windows' + - 'MacOS' + - 'Linux' + validations: + required: true + + - type: textarea + id: ansys-version + attributes: + label: '📀 Which ANSYS version are you using?' + placeholder: Indicate the ANSYS version of the products you are using. + + validations: + required: false + + - type: dropdown + id: python-version + attributes: + label: '🐍 Which Python version are you using?' + description: Run `python --version` to verify your Python version + multiple: false + options: + - '3.7' + - '3.8' + - '3.9' + - '3.10' + - '3.11' + validations: + required: true + + - type: textarea + id: installed-packages + attributes: + label: '📦 Installed packages' + description: Run `python -m pip freeze` to list installed packages + placeholder: Paste the output of `python -m pip freeze` here. + render: shell + validations: + required: true From 4cbbbc1601bb1c0a06300b90204ebf8ea3c47ef3 Mon Sep 17 00:00:00 2001 From: Paul Profizi <100710998+PProfizi@users.noreply.github.com> Date: Fri, 26 May 2023 15:34:17 +0200 Subject: [PATCH 2/2] Update .github/ISSUE_TEMPLATE/examples.yml Co-authored-by: JennaPaikowsky <98607744+JennaPaikowsky@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/examples.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/examples.yml b/.github/ISSUE_TEMPLATE/examples.yml index 6dcbf311309..f440f58c7de 100644 --- a/.github/ISSUE_TEMPLATE/examples.yml +++ b/.github/ISSUE_TEMPLATE/examples.yml @@ -21,7 +21,7 @@ body: label: '📁 Files needed for running the example' placeholder: > Drag and drop the files used in your example, together with the script employed. - Make sure that it runs on your machine, at the very least. + Test the example files before uploading to ensure they at least run on your machine. Add any additional comments/explanations that maintainers may need for running the example. If you have issues uploading your files because of the file extension/type, upload them as a .zip file.