Skip to content

Commit

Permalink
feat: adding new issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Armando Banuelos authored and Armando Banuelos committed Mar 7, 2024
1 parent a3ed9e2 commit f9cb0f0
Show file tree
Hide file tree
Showing 7 changed files with 245 additions and 29 deletions.
66 changes: 66 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: Bug Report
description: Create a report to help us reproduce and fix a bug
labels: ["type: bug", "status: triage"]

body:
- type: markdown
attributes:
value: >
#### Thank you for contributing! Before reporting a bug, please make sure it has no duplicate and/or has already been addressed by searching through [the existing and past issues](https://github.com/BerkeleyLearnVerify/Scenic/issues)
- type: textarea
attributes:
label: System Details
description: |
Please provide the following system information to help us diagnose the bug.
placeholder: |
1. Python Version: `python --version`
2. Scenic Version: `scenic --version`
3. Operating System / Platform: get from system preferences
Example:
1. Python Version: Python 3.11.7
2. Scenic Version: Scenic 3.0.0b2
3. Operating System / Platform: Apple M2 Pro macOS Sonoma 14.2.1
validations:
required: true

- type: textarea
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.
```
# error full stack trace
```
validations:
required: true

- type: textarea
attributes:
label: Steps To Reproduce
description: |
Please provide a minimal example to help us reproduce the bug. Code should be wrapped with ```` ```triple quotes blocks``` ```` to improve readability. If the code is too long, please attach as a file or create and link a public gist: https://gist.github.com.
Related data files (images, videos, etc) should be attached below as well. If the data files are too big, feel free to upload them to a online drive, share them and put the link below.
placeholder: |
1. First step to reproduce bug
2. Second step, etc
...
```
# sample code to reproduce the bug
```
validations:
required: true

- type: checkboxes
attributes:
label: Issue Submission Checklist
options:
- label: I report the issue, it's not a question
required: true
- label: I checked the open issues, forum, etc. and have not found any solution
- label: There is reproducer code and related data files (videos, images, online drive links, etc)
5 changes: 5 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Questions
url: https://scenic-lang.readthedocs.io/
about: Ask questions and discuss with Scenic community members
33 changes: 33 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Documentation
description: Report an issue or enhancement related to https://scenic-lang.readthedocs.io/
labels: ["type: documentation", "status: triage"]

body:
- type: markdown
attributes:
value: >
#### Thank you for contributing! Before submitting a doc issue, please make sure it has no duplicate and/or has already been addressed by searching through [the existing and past issues](https://github.com/BerkeleyLearnVerify/Scenic/issues)
- type: textarea
attributes:
label: Describe the doc issue or enhancement
description: >
Please provide a clear and concise description of what content in https://scenic-lang.readthedocs.io/ is an issue or needs enhancement.
placeholder: |
Link to location in the docs: https://scenic-lang.readthedocs.io/
validations:
required: true
- type: textarea
attributes:
label: Fix suggestion
description: >
Tell us how we could improve the documentation in this regard.
- type: checkboxes
attributes:
label: Issue Submission Checklist
options:
- label: I report the issue, it's not a question
required: true
- label: I checked the open issues, forum, etc. and have not found any solution
- label: There is reproducer code and related data files (videos, images, online drive links, etc)
31 changes: 31 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature Request
description: Submit a request for a new Scenic features
labels: ["type: feature", "status: triage"]

body:
- type: markdown
attributes:
value: >
#### Thank you for contributing! Before submitting a feature request, please make sure it has no duplicate and/or has already been addressed by searching through [the existing and past issues](https://github.com/BerkeleyLearnVerify/Scenic/issues)
- type: textarea
attributes:
label: Describe the feature and motivation
description: |
Please provide a clear and concise proposal of the feature and outline the motivation.
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: |
Add any other context, such as pseudo code, links, diagram, screenshots, to help the community better understand the feature request.
- type: checkboxes
attributes:
label: Issue Submission Checklist
options:
- label: I report the issue, it's not a question
required: true
- label: I checked the open issues, forum, etc. and have not found any solution
- label: There is reproducer code and related data files (videos, images, online drive links, etc)
29 changes: 0 additions & 29 deletions .github/workflows/ISSUE_TEMPLATE/issue_report.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/simulator_failure.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Simulator Failure
description: A failure regarding Scenic interaction with a simulator
labels: ["type: simulator", "status: triage"]

body:
- type: markdown
attributes:
value: >
#### Thank you for contributing! Before reporting a simulator failure, please make sure it has no duplicate and/or has already been addressed by searching through [the existing and past issues](https://github.com/BerkeleyLearnVerify/Scenic/issues)
- type: textarea
attributes:
label: Simulator Details
description: |
Please provide the following simulator information to help us diagnose the issue.
placeholder: |
1. Simulator Version: simulator details
2. Operating System / Platform: get from system preferences
Example:
1. Simulator Version: CARLA 0.9.14
2. Operating System / Platform: Apple M2 Pro macOS Sonoma 14.2.1
validations:
required: true

- type: textarea
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``` ````.
Related data files (images, videos, etc) should be attached below as well. If the data files are too big, feel free to upload them to a online drive, share them and put the link below.
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.
```
# error full stack trace
```
validations:
required: true

- type: checkboxes
attributes:
label: Issue Submission Checklist
options:
- label: I report the issue, it's not a question
required: true
- label: I checked the open issues, forum, etc. and have not found any solution
- label: There is reproducer code and related data files (videos, images, online drive links, etc)
60 changes: 60 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/test_failure.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Test Failure
description: A test failure in CI
labels: ["type: test", "status: triage"]

body:
- type: markdown
attributes:
value: >
#### Thank you for contributing! Before reporting a test failure, please make sure it has no duplicate and/or has already been addressed by searching through [the existing and past issues](https://github.com/BerkeleyLearnVerify/Scenic/issues)

- type: input
id: link
attributes:
label: CI Link
description: A link to a Github Actions or Jenkins job with the failure
validations:
required: true
- type: dropdown
id: reproducible
attributes:
label: Does it reproduce?
options:
- "Yes"
- "No"
- "Didn't try"
validations:
required: true

- type: input
id: branches
attributes:
label: Applicable branches
description: Branch names this failure has occurred on
validations:
required: true

- type: input
id: history
attributes:
label: Failure history
description: Link to build stats and possible indication of when this started failing and how often
validations:
required: false

- type: textarea
id: excerpt
attributes:
label: Failure excerpt
description: Please add a brief description of the error or exception that has occurred
validations:
required: true

- type: checkboxes
attributes:
label: Issue Submission Checklist
options:
- label: I report the issue, it's not a question
required: true
- label: I checked the open issues, forum, etc. and have not found any solution
- label: There is reproducer code and related data files (videos, images, online drive links, etc)

0 comments on commit f9cb0f0

Please sign in to comment.