diff --git a/.github/workflows/ISSUE_TEMPLATE/bug_report.yaml b/.github/workflows/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 000000000..768338ea4 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/bug_report.yaml @@ -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) \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/config.yaml b/.github/workflows/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 000000000..aad874b05 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/config.yaml @@ -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 \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/documentation.yaml b/.github/workflows/ISSUE_TEMPLATE/documentation.yaml new file mode 100644 index 000000000..a4d8bf4a5 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/documentation.yaml @@ -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) \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/feature_request.yaml b/.github/workflows/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 000000000..939710021 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/feature_request.yaml @@ -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) \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/issue_report.md b/.github/workflows/ISSUE_TEMPLATE/issue_report.md deleted file mode 100644 index cc2cf0665..000000000 --- a/.github/workflows/ISSUE_TEMPLATE/issue_report.md +++ /dev/null @@ -1,29 +0,0 @@ -### Issue Type -- [x] **Bug Report** -- [ ] **Feature Request** -- [ ] **Question** - -### System Details -1. Python Version: - -2. Scenic Version: - -3. Full Stack Trace: - -4. OS: - - -### Description - - -### Steps to Reproduce (***Bug Report only***) - - -### Expected Behavior - - -### Actual Behavior - - -### Additional Information - \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/simulator_failure.yaml b/.github/workflows/ISSUE_TEMPLATE/simulator_failure.yaml new file mode 100644 index 000000000..a7e84da98 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/simulator_failure.yaml @@ -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) \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/test_failure.yaml b/.github/workflows/ISSUE_TEMPLATE/test_failure.yaml new file mode 100644 index 000000000..2099faa6f --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/test_failure.yaml @@ -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) \ No newline at end of file