From 4884f5765b4a2d781c3c16eded921f025e0773f2 Mon Sep 17 00:00:00 2001 From: Ryan Johnson Date: Mon, 14 Oct 2024 09:50:06 -0400 Subject: [PATCH] chore: add issue templates Adds issue templates in the form format for bugs, documentation, and enhancements. Signed-off-by: Ryan Johnson --- .github/ISSUE_TEMPLATE/bug.yml | 143 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/docs.yml | 35 ++++++ .github/ISSUE_TEMPLATE/enhancement.yml | 48 +++++++++ 4 files changed, 227 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/docs.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..b6fe939de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,143 @@ +--- +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-nsxt/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. + + 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. + + Do not leave "+1" or other comments that do not add relevant information or questions. + + If you are interested in working on this issue or have submitted a pull request, please leave a comment. + + When filing an issue, please include the following information. + - 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-nsxt/releases/latest). + placeholder: e.g. x.y.x + validations: + required: true + - type: input + id: version-nsx + attributes: + label: VMware NSX + description: | + Please provide the VMware NSX 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 the output of the `crash.log` + placeholder: | + Paste the panic output or provider a link to a GitHub Gist. + 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..0086358db --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml new file mode 100644 index 000000000..5898585ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -0,0 +1,35 @@ +--- +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: 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" diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 000000000..742d7b828 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,48 @@ +--- +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. + + 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. + + Do not leave "+1" or other comments that do not add relevant information or questions. + + If you are interested in working on this enhancement or have submitted a pull request, please leave a comment. + + When filing an enhancement, please include the following information. + - 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