Skip to content

Commit

Permalink
add github issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
ericwang401 committed Nov 6, 2023
1 parent cb827d3 commit 18264ab
Show file tree
Hide file tree
Showing 3 changed files with 143 additions and 0 deletions.
100 changes: 100 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
name: Bug Report
description: Something isn't working quite right in the software.
labels: [not confirmed]
body:
- type: markdown
attributes:
value: |
Bug reports should only be used for reporting issues with how the software works. For assistance installing this software, as well as debugging issues with dependencies, please use our [Discord server](https://discord.convoypanel.com).
- type: textarea
attributes:
label: Current Behavior
description: Please provide a clear & concise description of the issue.
validations:
required: true

- type: textarea
attributes:
label: Expected Behavior
description: Please describe what you expected to happen.
validations:
required: true

- type: textarea
attributes:
label: Steps to Reproduce
description: Please be as detailed as possible when providing steps to reproduce, failure to provide steps will result in this issue being closed.
validations:
required: true

- type: textarea
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.

- type: input
attributes:
label: Proxmox OS Version
description: The version of your Proxmox node
placeholder: 7.4-13
validations:
required: true

- type: input
attributes:
label: Operating System
description: The OS you are using on your own computer to use Convoy.
placeholder: Windows 11 22H2
validations:
required: true

- type: input
attributes:
label: Browser
description: Your browser and its version
placeholder: e.g. Chrome 69, Firefox 420, Chromium 69, Edge 420
validations:
required: true

- type: textarea
attributes:
label: Additional Context
description: Add any other context about the problem here.

- type: input
id: panel-version
attributes:
label: Panel Version
description: Version number of your Panel (latest is not a version)
placeholder: 3.10.0-beta
validations:
required: true

- type: textarea
id: panel-logs
attributes:
label: Error Logs
description: |
Run the following command to collect logs of your Convoy installation. You will need to run this on the server
hosting your instance of Convoy.
```
wget https://github.com/ConvoyPanel/log-collector/releases/latest/download/log_collector
chmod +x ./log_collector
./log_collector
```
placeholder: "https://paste.frocdn.com/"
render: bash
validations:
required: false

- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please [search here](https://github.com/pterodactyl/panel/issues) to see if an issue already exists for your problem.
options:
- label: I have searched the existing issues before opening this issue.
required: true
- label: I have checked in the Discord server and believe this is a bug with the software, and not a configuration issue with my specific system.
required: true
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: Installation Help
url: https://discord.convoypanel.com
about: Please visit our Discord for help with your installation.
- name: General Question
url: https://discord.convoypanel.com
about: Please visit our Discord for general questions about Pterodactyl.
- name: Documentation
url: https://docs.convoypanel.com
about: Our documentation may have an answer for your issue/question.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Feature Request
description: Suggest a new feature or improvement for the software.
labels: [feature request]
body:
- type: checkboxes
attributes:
label: Is there an existing feature request for this?
description: Please [search here](https://github.com/convoypanel/panel/issues?q=is%3Aissue) to see if someone else has already suggested this.
options:
- label: I have searched the existing issues before opening this feature request.
required: true

- type: textarea
attributes:
label: Describe the feature you would like to see.
description: "A clear & concise description of the feature you'd like to have added, and what issues it would solve."
validations:
required: true

- type: textarea
attributes:
label: Describe the solution you'd like.
description: "You must explain how you'd like to see this feature implemented. Technical implementation details are not necessary, rather an idea of how you'd like to see this feature used."
validations:
required: true

- type: textarea
attributes:
label: Additional context to this request.
description: "Add any other context or screenshots about the feature request."
validations:
required: false

0 comments on commit 18264ab

Please sign in to comment.