Skip to content

Commit

Permalink
improve: issue templates
Browse files Browse the repository at this point in the history
This commit improves the issues templates using the new issue forms.
  • Loading branch information
ThePedroo committed Nov 17, 2023
1 parent 63aba21 commit 39bbbae
Show file tree
Hide file tree
Showing 4 changed files with 122 additions and 61 deletions.
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

This file was deleted.

39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md

This file was deleted.

49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Feature request
description: Ask for a new feature to be added
title: "[FR]: "
labels: ["enhancement", "not confirmed"]

body:
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the feature is.
validations:
required: true

- type: textarea
id: reason
attributes:
label: Reason
description: Why should this feature be added?
validations:
required: true

- type: textarea
id: example
attributes:
label: Example code
description: If you have an example of how this feature should be implemented, please share it here.
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Confirmations
description: The following confirmations are required to open a feature request.
options:
- label: This feature is not already implemented.
required: true
- label: I have verified that this is not a duplicate feature request.
required: true

- type: checkboxes
id: code_of_conduct
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/PerformanC/PerforVNMaker/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: Issue report
description: Report an issue
title: "[BUG]: "
labels: ["bug", "not confirmed"]

body:
- type: input
id: version
attributes:
label: PerforVNM version
description: The version of PerforVNM you're using.
validations:
required: true

- type: input
id: platform
attributes:
label: Platform
description: The platform you're using.
validations:
required: true

- type: input
id: platform_version
attributes:
label: Platform version
description: The version of the platform you're using.
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Steps to reproduce the behavior.
validations:
required: true

- type: textarea
id: example
attributes:
label: Example code
description: If you have an example of how to reproduce the bug, please share it here.
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Confirmations
description: The following confirmations are required to open a bug report.
options:
- label: My environment meets the minimum requirements.
required: true
- label: I have verified that this is not a duplicate issue.
required: true

- type: checkboxes
id: code_of_conduct
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/PerformanC/PerforVNMaker/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

0 comments on commit 39bbbae

Please sign in to comment.