Skip to content

Commit b5804b7

Browse files
Add examples.yml issue template (#964)
* Add examples.yml issue template * Update .github/ISSUE_TEMPLATE/examples.yml Co-authored-by: JennaPaikowsky <[email protected]> --------- Co-authored-by: JennaPaikowsky <[email protected]>
1 parent fa2888f commit b5804b7

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: 🎓 Adding an example
2+
description: Proposing a new example for the library
3+
title: "Example proposal: ..."
4+
labels: ["example"]
5+
assignees: [""]
6+
7+
body:
8+
9+
- type: textarea
10+
id: example-description
11+
attributes:
12+
label: '📝 Description of the example'
13+
placeholder: Describe what example you devised and why it is useful for the project.
14+
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: example-files
20+
attributes:
21+
label: '📁 Files needed for running the example'
22+
placeholder: >
23+
Drag and drop the files used in your example, together with the script employed.
24+
Test the example files before uploading to ensure they at least run on your machine.
25+
Add any additional comments/explanations that maintainers may need for running the example.
26+
If you have issues uploading your files because of the file extension/type, upload them
27+
as a .zip file.
28+
validations:
29+
required: true
30+
31+
- type: dropdown
32+
id: os-name
33+
attributes:
34+
label: '💻 Which operating system are you using?'
35+
multiple: false
36+
options:
37+
- 'Windows'
38+
- 'MacOS'
39+
- 'Linux'
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: ansys-version
45+
attributes:
46+
label: '📀 Which ANSYS version are you using?'
47+
placeholder: Indicate the ANSYS version of the products you are using.
48+
49+
validations:
50+
required: false
51+
52+
- type: dropdown
53+
id: python-version
54+
attributes:
55+
label: '🐍 Which Python version are you using?'
56+
description: Run `python --version` to verify your Python version
57+
multiple: false
58+
options:
59+
- '3.7'
60+
- '3.8'
61+
- '3.9'
62+
- '3.10'
63+
- '3.11'
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
id: installed-packages
69+
attributes:
70+
label: '📦 Installed packages'
71+
description: Run `python -m pip freeze` to list installed packages
72+
placeholder: Paste the output of `python -m pip freeze` here.
73+
render: shell
74+
validations:
75+
required: true

0 commit comments

Comments
 (0)