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 #353

Merged
merged 4 commits into from
Apr 4, 2023
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
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ body:
label: Before submitting the issue
description: Please, make sure the following conditions are met
options:
- label: I have checked for [Compatibility](https://dpf.docs.pyansys.com/getting_started/index.html#compatibility) issues
- label: I have checked for [Compatibility](https://dpf.docs.pyansys.com/version/stable/getting_started/index.html#compatibility) issues
required: true
- label: I have searched among the existing issues
required: true
Expand Down Expand Up @@ -66,6 +66,7 @@ body:
- '3.8'
- '3.9'
- '3.10'
- '3.11'
validations:
required: true

Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/examples.yml
Original file line number Diff line number Diff line change
@@ -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