Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Issue Templates & Config #644

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/clarification-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Clarification Request
description: Create a report to help us improve the clarity of the Documentation
title: "[Clarification Request]: "
labels: []
assignees: []

body:
- type: checkboxes
id: already_searched
attributes:
label: "Have you checked if this is already explained elsewhere in the documentation?"
options:
- label: "Yes, but I still need clarification."
required: true
- type: markdown
attributes:
value: "### Please fill in all required fields before submitting."

- type: input
id: clarif_description
attributes:
label: "Describe the issue"
description: "A clear and concise description of what needs to be clarified."
placeholder: "Write your issue here..."
validations:
required: true # This prevents empty reports

- type: textarea
id: clarif_fix
attributes:
label: "Proposed Clarification Steps"
description: "What should we change to clarify this section of the Documentation?"
placeholder: "Add your suggestion on how to clarify this section here..."
validations:
required: true
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: Pterodactyl Discord Server
url: https://discord.gg/pterodactyl
about: For issues setting up and running Pterodactyl please go here
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Enhancement
description: Tell us how to improve the documentation
title: "[Enhancement]: "
labels: []
assignees: []
body:
- type: checkboxes
id: already_searched
attributes:
label: "Have you checked if this is already explained elsewhere in the documentation?"
options:
- label: "Yes"
required: true
- type: markdown
attributes:
value: "### Please fill in all required fields before submitting."
- type: textarea
id: what-to-add
attributes:
label: "Proposed Enhancement"
description: What do you want to see added to the Documentation?
placeholder: Tell us what needs to be added!
validations:
required: true