Skip to content

Commit c3b43dd

Browse files
authored
Update bug report template
1 parent f9fa0d2 commit c3b43dd

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,49 +7,54 @@ body:
77
- type: markdown
88
attributes:
99
value: |
10-
> **🚧 If you have SentinelOne installed as an antivirus, look no further.**
11-
> **You will need to create exceptions for Revit and pyRevit, both on the software and the %appdata% folders.**
10+
## Please fill this form properly! 🙏🙏🙏
11+
We're running on limited resources, so we don't have much time to get back to you if you don't provide enough info.
12+
Please make a little effort, do your research and [ask questions the smart way](http://www.catb.org/~esr/faqs/smart-questions.html#beprecise).
13+
**If you didn't fill the form properly or lie about the pre-flight checks, the issue could be closed without any explanation!**
14+
## 🚧🚧 Revit 2025 🚧🚧
15+
pyRevit 4.8.x is not compatible with Revit 2025. If you really need it, you can try (**at your own risk!**) the WIP version that you can find at [this page](https://www.pyrevitlabs.io/)
16+
## 🚧 SentinelOne 🚧
17+
If you have SentinelOne installed as an antivirus, **look no further**.
18+
**You will need to create exceptions for Revit and pyRevit**, both on the software and the %appdata% folders. ask your IT guy to do that.
1219
- type: checkboxes
1320
id: preflight
1421
attributes:
1522
label: ✈ Pre-Flight checks
16-
description: before submitting an issue, make sure you've checked the following
23+
description: before submitting an issue, make sure you've checked the following.
1724
options:
1825
- label: I **don't have SentinelOne** antivirus installed (see above for the solution)
19-
required: true
2026
- label: I have **searched in the issues** (open and closed) but couldn't find a similar issue
21-
required: true
2227
- label: I have **searched in the [pyRevit Forum](https://discourse.pyrevitlabs.io)** for similar issues
23-
required: true
2428
- label: I already **followed the [installation troubleshooting guide](https://pyrevitlabs.notion.site/Installation-issues-f6495adb56254e9e8021f8a68e3b2ab7) thoroughly**
25-
required: true
2629
- label: I am using the **latest pyRevit Version**
27-
required: true
2830
- type: textarea
2931
id: description
3032
attributes:
3133
label: 🐞 Describe the bug
32-
description: Be as specific as possible and list steps to reproduce the issue.
34+
description: Be **as specific as possible**. see "how to ask questions the smart way" above
3335
validations:
3436
required: true
3537
- type: textarea
3638
id: error-message
3739
attributes:
3840
label: ⌨ Error/Debug Message
39-
description: If you have any suggestions for the solution, please list that as well. Issues related to tools/scripts, I tried to run them in debug mode (CTRL+click on the button) and copy over the contents of the output window.
41+
description: |
42+
Post the text (preferred) or screenshot of the error, if any.
43+
For issues related to tools/scripts, run them in debug mode (CTRL+click on the button) and copy over the contents of the output window (use the copy button in the title bar and paste it here).
4044
render: shell
4145
validations:
4246
required: true
4347
- type: textarea
4448
id: reproduce-steps
4549
attributes:
4650
label: ♻️ To Reproduce
47-
description: Steps to reproduce the behavior
51+
description: Steps to reproduce the behavior. Tell us exactly what you did so that we can try to reproduce on our own computers.
4852
placeholder: |
4953
1. Go to '...'
5054
2. Click on '....'
51-
3. Scroll down to '....'
52-
4. See error
55+
3. Select '....'
56+
4. Type '...'
57+
5. See error
5358
- type: textarea
5459
id: expected-behavior
5560
attributes:
@@ -59,12 +64,15 @@ body:
5964
id: env
6065
attributes:
6166
label: 🖥️ Hardware and Software Setup (please complete the following information)
62-
description: Open a command prompt 🖥 and run the command `pyrevit env`. Paste the output here.
67+
description: |
68+
Open a command prompt 🖥 and run the command `pyrevit env`. Paste the output here.
69+
**This is super important for us to know if there's something wrong/specific in your setup!**
70+
Not filling this may result in the issue to be closed without explanation.
6371
render: shell
6472
validations:
6573
required: true
6674
- type: textarea
6775
id: context
6876
attributes:
6977
label: Additional context
70-
description: Add any other context about the problem here.
78+
description: Add any other context about the problem here. If you have any suggestions for the solution, please list that as well.

0 commit comments

Comments
 (0)