Skip to content

Commit 58ab4fc

Browse files
authored
Improving bug template (#2091)
1 parent 89ada8a commit 58ab4fc

File tree

1 file changed

+21
-27
lines changed

1 file changed

+21
-27
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 21 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 🐞 Bug, problem, error
1+
name: 🐞 Bug, problem, or error
22
description: Fill a bug report here
33
title: "Bug located in ..."
44
labels: ["bug"]
@@ -13,38 +13,36 @@ body:
1313
- type: checkboxes
1414
id: new-bug
1515
attributes:
16-
label: Before submitting the issue
16+
label: 🤓 Before submitting the issue
1717
description: |
1818
Ensure that the following conditions are met.
1919
20-
Visit [Troubleshooting section](https://mapdl.docs.pyansys.com/troubleshoot/index.html) for more information.
21-
2220
options:
23-
- label: I have visited the Troubleshooting section.
21+
- label: I have visited the [Troubleshooting section](https://mapdl.docs.pyansys.com/troubleshoot/index.html).
2422
required: true
25-
- label: I have searched among the existing issues.
23+
- label: I have searched among the [existing issues](https://github.com/ansys/pymapdl/issues?q=).
2624
required: true
27-
- label: I am using a Python virtual environment.
25+
- label: I am using a [Python virtual environment](https://docs.python.org/3/library/venv.html).
2826
required: true
29-
- label: I have a fully updated virtual environment (i.e. ``pip install --upgrade --upgrade-strategy eager ansys-mapdl-core``)
27+
- label: I am using the [latest version of PyMAPDL](https://github.com/ansys/pymapdl/releases) and its dependencies (fully updated virtual environment). You can update them using ``pip install --upgrade --upgrade-strategy eager ansys-mapdl-core``.
3028
required: true
3129

3230
- type: textarea
3331
id: bug-description
3432
attributes:
35-
label: Description of the bug
33+
label: 🔍 Description of the bug
3634
placeholder: Describe what bug you encountered and what should have happened.
3735
validations:
3836
required: true
3937

4038
- type: textarea
4139
id: steps-to-reproduce
4240
attributes:
43-
label: Steps To Reproduce
41+
label: 🕵️ Steps To Reproduce
4442
description: |
4543
Please write the steps in a list form e.g.:
4644
* Install this package...
47-
* Run this input file (attached)
45+
* Run this input file (Please attach it) and/or
4846
* Run the following commands:
4947
```py
5048
mapdl.command1()
@@ -53,6 +51,8 @@ body:
5351
```
5452
* Check obtained error...
5553
54+
Use the following text box:
55+
5656
value: |
5757
Steps:
5858
* First I did...
@@ -79,7 +79,7 @@ body:
7979
- type: dropdown
8080
id: os-name
8181
attributes:
82-
label: Which Operating System are you using?
82+
label: 💻 Which Operating System are you using?
8383
multiple: false
8484
options:
8585
- 'Windows'
@@ -91,26 +91,25 @@ body:
9191
- type: dropdown
9292
id: python-version
9393
attributes:
94-
label: Which Python version are you using?
94+
label: 🐍 Which Python version are you using?
9595
description: Run `python --version` to verify your Python version
9696
multiple: false
9797
options:
9898
- '3.7'
9999
- '3.8'
100100
- '3.9'
101101
- '3.10'
102+
- '3.11'
102103
validations:
103104
required: false
104105

105106
- type: textarea
106107
id: pymapdl-report
107108
attributes:
108-
label: PyMAPDL Report
109+
label: 📝 PyMAPDL Report
109110
description: Run `python -c "from ansys.mapdl import core as pymapdl; print(pymapdl.Report())"` to get the PyMAPDL Report
110111
value: |
111-
<details><summary>
112-
Show the Report!
113-
</summary>
112+
<details><summary>Show the Report!</summary>
114113
115114
```text
116115
@@ -125,12 +124,10 @@ body:
125124
- type: textarea
126125
id: installed-packages
127126
attributes:
128-
label: Installed packages
127+
label: 📝 Installed packages
129128
description: Run `python -m pip freeze` to list installed packages
130129
value: |
131-
<details><summary>
132-
Show the installed packages!
133-
</summary>
130+
<details><summary>Show the installed packages!</summary>
134131
135132
```text
136133
@@ -145,16 +142,13 @@ body:
145142
- type: textarea
146143
id: logger_log
147144
attributes:
148-
label: Logger output file
145+
label: 📝 Logger output file
149146
description: |
150147
Attach the logger output file. For more information on how to set the logger and
151-
attach its output file, see the [Troubleshooting section]
152-
(https://mapdl.docs.pyansys.com/troubleshoot/index.html).
148+
attach its output file, see the [Troubleshooting section](https://mapdl.docs.pyansys.com/version/stable/user_guide/troubleshoot.html).
153149
154150
value: |
155-
<details><summary>
156-
Show the logger output file.
157-
</summary>
151+
<details><summary>Show the logger output file.</summary>
158152
159153
```text
160154

0 commit comments

Comments
 (0)