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

chore: add issue templates #553

Merged
merged 1 commit into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
151 changes: 151 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
---
name: Bug Report
description: Is something not working as expected? Submit a bug.
labels:
- [bug, needs-triage]
body:
- type: markdown
attributes:
value: |
Before filing an issue, please [search the existing issues](https://github.com/vmware/terraform-provider-vra/issues?q=is%3Aissue+is%3Aopen+label%3Abug) (open or closed), and use the [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) feature to add up-votes to existing issues.

When filing an issue, please include the following information.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: The Code of Conduct applies to you when interacting with the community here on GitHub and contributing code.
options:
- label: I have read and agree to the [Code of Conduct](https://github.com/vmware/terraform-provider-vra/blob/main/CODE_OF_CONDUCT.md).
required: true
- label: Vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue initial description to help the maintainers prioritize.
required: false
- label: Do not leave "+1" or other comments that do not add relevant information or questions.
required: false
- label: If you are interested in working on this issue or have submitted a pull request, please leave a comment.
required: false
- type: input
id: version-terraform
attributes:
label: Terraform
description: Please provide the Terraform version.
placeholder: e.g. x.y.z
validations:
required: true
- type: input
id: version-provider
attributes:
label: Terraform Provider
description: |
Please provide the provider version.
We recommend testing with [the latest version of the provider](https://github.com/vmware/terraform-provider-vra/releases/latest).
placeholder: e.g. x.y.x
validations:
required: true
- type: input
id: version-product
attributes:
label: VMware Aria Automation
description: |
Please provide the VMware Aria version.
placeholder: e.g. x.y.z
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: Please provide a clear and concise description of the issue you are experiencing.
validations:
required: true
- type: textarea
id: affected-resources-datasources
attributes:
label: Affected Resources or Data Sources
description: Please provide the affected resources or data sources as a list.
placeholder: |
e.g. `resource/example` or `datasource/example`
validations:
required: true
- type: textarea
id: configuration
attributes:
label: Terraform Configuration
description: |
- Please provide a code repository, [GitHub Gist](https://gist.github.com/), or simplified code sample suitable for issue reproduction.
- Please ensure all secrets and identifiable information is removed.
- Please format any code in code blocks using the markdown editor.

Learn more about [Code Formatting](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code).
placeholder: |
Please format any code in code blocks using the markdown editor.
validations:
required: true
- type: textarea
id: debug
attributes:
label: Debug Output
description: |
Please provide a link to a [GitHub Gist](https://gist.github.com/) containing the complete debug output.
placeholder: |
Link to a GitHub Gist. Please do not paste the debug output in the issue.
validations:
required: true
- type: textarea
id: panic
attributes:
label: Panic Output
description: |
If Terraform produced a panic, please provide a link to a [GitHub Gist](https://gist.github.com/) containing the output of the `crash.log`
placeholder: |
Link to a GitHub Gist. Please do not paste the panic output in the issue.
validations:
required: false
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: |
What is it you expected to happen?
This should be a description of how the functionality you tried to use is supposed to work.
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior
description: What actually happened that's different from the expected behavior?
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Please provide the steps to reproduce the issue.
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment Details
description: Please add any additional information you can provide about the environment.
validations:
required: false
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Screenshots of the issue, if applicable.
validations:
required: false
- type: textarea
id: references
attributes:
label: References
description: |
Please provide any related GitHub issues or pull requests (open or closed) or documentation.
Learn about [Referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests).
placeholder: |
#GH-0000
validations:
required: false
79 changes: 0 additions & 79 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Documentation
description: Found a typo or something that needs clarification?
labels:
- [documentation, needs-review]
body:
- type: markdown
attributes:
value: >
When filing a documentation issue, please include the following information.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: >-
This project has a [Code of Conduct](https://github.com/vmware/terraform-provider-tanzu-mission-control/blob/main/CODE_OF_CONDUCT.md)
that all participants are expected to understand and follow.
options:
- label: I have read and agree to the project's Code of Conduct.
required: true
- type: input
id: version-provider
attributes:
label: Provider Version
description: Please provide the provider version.
placeholder: e.g. x.y.z
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: Why should we update our docs or examples?
validations:
required: false
- type: textarea
id: suggestion
attributes:
label: Suggestion
description: What should we do instead?
validations:
required: false
- type: markdown
attributes:
value: "### Community Note\n* Please vote on this issue by adding a \U0001F44D [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request\n* Please do not leave \"+1\" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request\n* If you are interested in working on this issue or have submitted a pull request, please leave a comment\n"
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
name: Enhancement Request
description: Is something critical missing? Suggest an enhancement.
labels:
- [enhancement, needs-review]
body:
- type: markdown
attributes:
value: >
Before filing an enhancement, please search the existing issues and use the
[reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)
feature to add up-votes to existing requests.


When filing an enhancement, please include the following information.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: >-
This project has a [Code of Conduct](https://github.com/vmware/terraform-provider-tanzu-mission-control/blob/main/CODE_OF_CONDUCT.md)
that all participants are expected to understand and follow.
options:
- label: I have read and agree to the project's Code of Conduct.
required: true
- label: Vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue initial description to help the maintainers prioritize.
required: false
- label: Do not leave "+1" or other comments that do not add relevant information or questions.
required: false
- label: If you are interested in working on this issue or have submitted a pull request, please leave a comment.
required: false
- type: textarea
id: description
attributes:
label: Description
description: A written overview of the enhancement.
validations:
required: true
- type: textarea
id: use-case
attributes:
label: Use Case(s)
description: Any relevant use-cases that you see.
validations:
required: true
- type: textarea
id: potential-configuration
attributes:
label: Potential Configuration
description: Provide a potential configuration.
validations:
required: true
- type: textarea
id: references
attributes:
label: References
description: Provide any references.
validations:
required: false
36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

Loading