Skip to content

Commit

Permalink
[mirotalksfu] - imporve issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
miroslavpejic85 committed Aug 17, 2024
1 parent ec95711 commit b49a927
Show file tree
Hide file tree
Showing 6 changed files with 116 additions and 83 deletions.
48 changes: 0 additions & 48 deletions .github/ISSUE_TEMPLATE/---bug-report.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/---feature-request.md

This file was deleted.

15 changes: 0 additions & 15 deletions .github/ISSUE_TEMPLATE/--question---discussion---feedback-.md

This file was deleted.

85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: Bug report
description: File a bug report and help us improve
#labels: ["bug"]
body:
- type: markdown
attributes:
value: |
This issue tracker is only for reporting bugs and tracking issues related to the source code.
**Before posting, please make sure to check if the same or similar bugs have already been reported.**
⚠️ General questions regarding usage, installation, etc. should be posted in our [community forum](https://discord.gg/rgGYfeYW3N).
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Steps to reproduce the behavior.
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: markdown
attributes:
value: "**Please select at least one device where the problem occurs.**"

- type: checkboxes
attributes:
label: Device
description: Please provide the device where the problem manifests.
options:
- label: Android
- label: iPhone
- label: Linux
- label: Mac
- label: Windows
- type: markdown
attributes:
value: "**Please select at least one browser where the problem occurs.**"

- type: checkboxes
attributes:
label: Browser
description: Please provide the browser where the problem manifests.
options:
- label: Chrome (or Chromium based)
- label: Firefox
- label: Safari
- label: Android browser
- label: iOS browser
- label: Other desktop browser
- type: textarea
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. The browser console logs (if applicable) is a good start. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: markdown
attributes:
value: "**Please indicate whether the problem is reproducible on sfu.mirotalk.com.**"

- type: checkboxes
attributes:
label: Reproducibility
description: Is the bug reproducible on sfu.mirotalk.com?
options:
- label: Yes
- label: No
- type: textarea
attributes:
label: Additional context
description: Please provide more details in case they apply (such as the MiroTalk SFU version you are running, if you are hosting your own server).
- type: markdown
attributes:
value: |
**Attach images or screenshots**
If applicable, you can drag and drop images directly into this issue. Screenshots or videos can help illustrate the problem clearly.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Feature request
description: Suggest an idea for MiroTalk SFU
labels: ["feature-request"]
body:
- type: markdown
attributes:
value: |
Thank you for suggesting an idea to make MiroTalk SFU better.
**Note**: the ultimate decision for implementing features lies on the MiroTalk team, not all feature requests shall be accepted.
- type: textarea
attributes:
label: Feature request
description: A clear and concise description of the feature request.
validations:
required: true
- type: textarea
attributes:
label: Pros
description: A clear and concise description of the feature request pros.
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context about the feature request here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Community Forum
url: https://discord.gg/rgGYfeYW3N
about: Ask questions and get help from the community.

0 comments on commit b49a927

Please sign in to comment.