Skip to content

Commit

Permalink
fix: add more clarity to issue templates (#250)
Browse files Browse the repository at this point in the history
* fix: add more clarity to issue templates

* fix: updating enumeration

---------

Co-authored-by: Armando Banuelos <abanuelo@Armandos-MacBook-Pro.local>
  • Loading branch information
abanuelo and Armando Banuelos committed Apr 27, 2024
1 parent 960a5f1 commit eb4c4b1
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 9 deletions.
15 changes: 10 additions & 5 deletions .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,16 @@ body:
attributes:
label: Detailed Description
description: |
Please provide a clear and concise description of what the bug is and paste the error log below. Please rerun your simulation error with the **`-b`** parameter for a full stack trace.
It helps improving readability if the error log is wrapped in ```triple quotes blocks```.
placeholder: |
A clear and concise description of what the bug is. You can rerun your Scenic simulation with `-b` to get a full stack trace.
Please provide a clear and concise description of what the bug is and paste the error log below.
1. Clear and concise description of the bug
2. `scenic` command you ran locally (e.g. `scenic test.scenic --count 1 -b`, etc.). Please rerun your simulation error with the **`-b`** parameter for a full stack trace.
3. Error log. It helps improving readability if the error log is wrapped in ```triple quotes blocks```.
placeholder: |
1. Scenic has a bug
2. `scenic test.scenic -b`
3. Error Log
```
# error full stack trace
```
Expand Down Expand Up @@ -67,5 +72,5 @@ body:
options:
- label: I am reporting an issue, not asking a question
required: true
- label: I checked the open issues, forum, etc. and have not found any solution
- label: I checked the open and closed issues, forum, etc. and have not found any solution
- label: I have provided all necessary code, etc. to reproduce the issue
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/2-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ body:
- type: markdown
attributes:
value: >
#### Thank you for contributing! Before submitting a doc issue, please make sure it has no duplicate and has not already been addressed by searching through [the existing and past issues](https://github.com/BerkeleyLearnVerify/Scenic/issues)
#### Thank you for contributing! Before submitting a doc issue, please make sure it has no duplicate and has not already been addressed by searching through [the existing and past open and closed issues](https://github.com/BerkeleyLearnVerify/Scenic/issues)
- type: textarea
attributes:
Expand All @@ -32,4 +32,4 @@ body:
options:
- label: I am reporting an issue, not asking a question
required: true
- label: I checked the open issues, forum, etc. and have not found any solution
- label: I checked the open and closed issues, forum, etc. and have not found any solution
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/3-feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ body:
- type: markdown
attributes:
value: >
#### Thank you for contributing! Before submitting a feature request, please make sure it has no duplicate and has not already been addressed by searching through [the existing and past issues](https://github.com/BerkeleyLearnVerify/Scenic/issues)
#### Thank you for contributing! Before submitting a feature request, please make sure it has no duplicate and has not already been addressed by searching through [the existing and past open and closed issues](https://github.com/BerkeleyLearnVerify/Scenic/issues)
- type: textarea
attributes:
Expand All @@ -28,4 +28,4 @@ body:
attributes:
label: Issue Submission Checklist
options:
- label: I checked the open issues, forum, etc. and have not found any solution
- label: I checked the open and closed issues, forum, etc. and have not found any solution

0 comments on commit eb4c4b1

Please sign in to comment.