Update documentation_template.yaml, feature_request_template.yaml, question_template.yaml, and 2 more files: added 2 new templates adn added punctuation to the old ones

This commit is contained in:
Tommy koning 2024-05-13 01:19:03 +02:00
parent a5ff005930
commit bcc5be91b8
5 changed files with 76 additions and 9 deletions

View File

@ -0,0 +1,29 @@
name: Request new documentation
about: Request new documentation or a change to existing documentation
title: "[Docs]: "
labels: ["Priority low", "Kind/Documentation", "Management"]
body:
- type: markdown
attributes:
value:
This issue was created by an issue **template** :)
visible: [content]
- type: input
id: section
attributes:
label: where would you like new or different documentation ?
description: Specify which part of the documentation needs updating.
placeholder: Where do we need to update the documentation ?
validations:
required: true
- type: textarea
id: current
attributes:
label: Please provide the current documentation if applicable
description: Provide the existing content that needs modification.
placeholder: please link to the documentation or send the whole document and dont send pictures
- type: textarea
id: changes
attributes:
label: How would you describe it ?
description: Outline the changes you propose to make.

View File

@ -11,8 +11,8 @@ body:
- type: textarea
id: Request
attributes:
label: What would you like to see Implemented
description: Please describe this feature in detail
label: What would you like to see Implemented.
description: Please describe this feature in detail.
placeholder: Tell us what you want to see added!
value: "as a user i would like "
validations:
@ -21,8 +21,8 @@ body:
id: functional
attributes:
label: (Optional) What would the functional requirements be ?
description: Please describe this feature's functionality in detail
placeholder: Tell us how this feature would work
description: Please describe this feature's functionality in detail.
placeholder: Tell us how this feature would work.
value: "if i a user/admin/developer would preform would do x this then y would happen"
validations:
required: false
@ -30,8 +30,8 @@ body:
id: technical
attributes:
label: (Optional) What would the technical requirements be ?
description: Please describe this feature's technical requirements
placeholder: Tell us how this feature would work behind the scenes
description: Please describe this feature's technical requirements.
placeholder: Tell us how this feature would work behind the scenes.
value: "if i a user/admin/developer would preform this action the application would"
validations:
required: false

View File

@ -0,0 +1,38 @@
name: Ask a question
about: Ask a question that about this project
title: "[Question]: "
labels: ["Priority low", "Kind/Documentation", "Management"]
body:
- type: markdown
attributes:
value:
This issue was created by an issue **template** :)
visible: [content]
- type: input
id: question
attributes:
label: Ask your question clearly and concisely.
description: Please ask your question.
placeholder: Tell us what you want to know!
validations:
required: true
- type: textarea
id: context
attributes:
label: Provide any relevant context or background information.
description: Please add the details of your question here.
placeholder: What is this question really about ?
- type: textarea
id: attempts
attributes:
label: Did you make any attempt solve this yourself if so how ?
description: Explain any attempts you've made to solve the issue yourself.
placeholder: What did you try ?
- type: textarea
id: resolution
attributes:
label: How did you expect this to work ?
description: What is your expected resolution ?
placeholder: Describe what you hope to achieve with the answer.
validations:
required: true

View File

@ -5,14 +5,14 @@ labels: ["Priority low"]
body:
- type: markdown
attributes:
value: |
value:
This issue was created by an issue **template** :)
visible: [content]
- type: input
id: task
attributes:
label: What needs to happened?
description: Keep it short, sweet and simple
description: Keep it short, sweet and simple.
placeholder: Tell us what to do!
validations:
required: true

View File

@ -20,7 +20,7 @@ body:
id: related_issue
attributes:
label: Does this fix a issue or add a requested feature ?
description: If this pull requests fixes a known issue or adds requested functionality please link that issue number here
description: If this pull requests fixes a known issue or adds requested functionality please link that issue number here.
validations:
is_number: true
required: false