add github issue templates

This commit is contained in:
clifford 2022-01-17 15:19:40 -08:00
parent 24bf4cb5fb
commit 31e3bd69f2
3 changed files with 147 additions and 0 deletions

99
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -0,0 +1,99 @@
name: '🐛 Bug report'
description: Report a reproducible bug or regression
body:
- type: markdown
attributes:
value: |
Thank you for reporting an issue :pray:
This issue tracker is for reporting reproducible bugs or regression's found in [excalidraw](https://github.com/excalidraw/excalidraw)
If you have a question about how to achieve something and are struggling, please post a question
inside of excalidraw's [Discussions tab](https://github.com/excalidraw/excalidraw/discussions)
Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
- excalidraw's [Discussions tab](https://github.com/excalidraw/excalidraw/discussions)
- excalidraw's [Open Issues](https://github.com/excalidraw/excalidraw/discussions/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
- excalidraw's [Closed Issues](https://github.com/excalidraw/excalidraw/discussions/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
The more information you fill in, the better the community can help you.
- type: textarea
id: description
attributes:
label: Describe the bug
description: Provide a clear and concise description of the challenge you are running into.
validations:
required: true
- type: input
id: excalidraw-link
attributes:
label: Your minimal, reproducible example
description: |
Please share a link to your excalidraw file.
1. Export your excalidraw file to your computer
2. Copy the content of the `.excalidraw` file (FYI: this is actually JSON content)
3. Open the following page to share your copied code & call the filename `my-excalidraw.json`: https://gist.github.com/
Note:
- Your bug may get fixed much faster if we can run your code
- Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
placeholder: |
A link to your excalidraw file: https://gist.github.com/....
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Describe the steps we have to take to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
description: Provide a clear and concise description of what you expected to happen.
placeholder: |
As a user, I expected ___ behavior but i am seeing ___
validations:
required: true
- type: dropdown
attributes:
label: How often does this bug happen?
description: |
Following the repro steps above, how easily are you able to reproduce this bug?
options:
- Every time
- Often
- Sometimes
- Only once
- type: textarea
id: screenshots_or_videos
attributes:
label: Screenshots or Videos
description: |
If applicable, add screenshots or a video to help explain your problem.
For more information on the supported file image/file types and the file size limits, please refer
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
placeholder: |
You can drag your video or image files inside of this editor ↓
- type: textarea
id: platform
attributes:
label: Platform
description: |
Please let us know which Operting System, Browser and Browser version you were using when the issue occurred.
placeholder: |
- OS: [e.g. macOS, Windows, Linux, iOS, Android]
- Browser: [e.g. Chrome, Safari, Firefox, React Native]
- Version: [e.g. 91.1]
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here.

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Feature Requests & Questions
url: https://github.com/excalidraw/excalidraw/discussions
about: Please ask and answer questions here.

View file

@ -0,0 +1,43 @@
name: 'Feature Request'
description: Suggest a new feature
body:
- type: markdown
attributes:
value: |
Thank you for tacking the time to request a new feature :pray:
This form for suggesting new feature's or enhancements for [excalidraw](https://github.com/excalidraw/excalidraw)
If you have a question about how to achieve something and are struggling, please post a question
inside of excalidraw's [Discussions tab](https://github.com/excalidraw/excalidraw/discussions)
Before submitting a feature request, please check the links below to see if there is a solution, feature request or question posted there already:
- excalidraw's [Discussions tab](https://github.com/excalidraw/excalidraw/discussions)
- excalidraw's [Open Issues](https://github.com/excalidraw/excalidraw/discussions/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
- excalidraw's [Closed Issues](https://github.com/excalidraw/excalidraw/discussions/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
The more information you fill in, the better the community can help you.
- type: textarea
id: steps
attributes:
label: Describe the feature you would like see in Excalidraw
description: Provide a clear and concise description.
placeholder: |
Ex. I'm always frustrated when [...]
Ex. I wish there was a way to do [...]
validations:
required: true
- type: textarea
id: screenshots_or_videos
attributes:
label: Screenshots or Videos
description: |
If applicable, add screenshots or a video to help explain your problem.
For more information on the supported file image/file types and the file size limits, please refer
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
placeholder: |
You can drag your video or image files inside of this editor ↓
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here.