From ac375ad23dca6b9cbd56ae63c3a84bea1a0461f7 Mon Sep 17 00:00:00 2001 From: Nara Kasbergen Date: Fri, 2 Jun 2023 14:50:25 +0200 Subject: [PATCH] Switch to GitHub issue form templates --- .copywrite.hcl | 3 +- .github/ISSUE_TEMPLATE/bug_report.md | 72 ---------- .github/ISSUE_TEMPLATE/bug_report.yml | 152 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.yml | 52 +++++++ .github/ISSUE_TEMPLATE/feature_request.md | 55 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 114 ++++++++++++++++ 6 files changed, 320 insertions(+), 128 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.copywrite.hcl b/.copywrite.hcl index 564b01388..39905792c 100644 --- a/.copywrite.hcl +++ b/.copywrite.hcl @@ -7,6 +7,7 @@ project { # Supports doublestar glob patterns for more flexibility in defining which # files or folders should be ignored header_ignore = [ - "**/testdata/**" + "**/testdata/**", + ".github/ISSUE_TEMPLATE/**", ] } diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 80a1422b2..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -name: Bug report -about: Let us know about an unexpected error, a crash, or an incorrect behavior. - ---- - -### Server Version - -``` - -``` - -### Terraform Version - -``` - -``` - -### Client Version - -``` - -``` - -### Terraform Configuration Files - - -```hcl - -``` - -### Log Output - - -### Expected Behavior - - -### Actual Behavior - - -### Steps to Reproduce - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..fc9af1a85 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,152 @@ +name: "Bug report" +description: "Let us know about an unexpected error, a crash, or an incorrect behavior." +labels: [bug] +assignees: [] +body: + - type: markdown + attributes: + value: We use GitHub issues for tracking bugs and enhancements. For questions, please use [the community forum](https://discuss.hashicorp.com/c/terraform-core/terraform-editor-integrations/) where there are more people ready to help. + + - type: input + id: version + attributes: + label: Language Server Version + description: | + Run `terraform-ls --version` to show the version. + If you are not running the latest version, please try upgrading because your issue may have already been fixed. + placeholder: v0.31.2 + validations: + required: true + + - type: input + id: terraform + attributes: + label: Terraform Version + description: | + Run `terraform -v` to show the version. Make sure you are running the same binary that the language server would normally pick up from $PATH if you have more than one version installed on your system. + placeholder: Terraform v1.4.6 on darwin_arm64 + validations: + required: true + + - type: input + id: client + attributes: + label: Client Version + description: | + Please share what IDE and/or plugin interacts with the server. + placeholder: Sublime Text (LSP plugin) v0.9.7 + validations: + required: true + + - type: textarea + id: configuration + attributes: + label: Terraform Configuration + description: | + Include the relevant Terraform configuration that might be helpful for reproducing your issue. + Please remove any sensitive information such as passwords before sharing configuration snippets. + + For large Terraform configs, please use a service like Dropbox and share a link to the ZIP file. + For security, you can optionally encrypt the files using [HashiCorp's GPG public key](https://www.hashicorp.com/security#secure-communications). + placeholder: | + resource "github_repository" "test" { + name = "vscode-terraform" + } + + # etc... + render: terraform + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: | + Please list the steps required to reproduce the issue. If applicable, add screenshots to help explain your problem. + placeholder: | + 1. Open a folder in IDE XYZ + 2. Open file example.tf from that folder + 3. Trigger autocompletion on line 5, column 1 (1-indexed) + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: | + What should have happened? Please give a clear and concise description in plain English. + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: | + What actually happened? Please give a clear and concise description in plain English. + validations: + required: true + + - type: input + id: gist + attributes: + label: Gist + description: | + If possible, please provide a link to a [GitHub Gist](https://gist.github.com/) your full debug output. Do *NOT* paste +the debug output in the issue, since it may be long. + + Full debug output can be obtained by launching the server with a particular flag (e.g. `-log-file`). + Please follow the instructions in [`docs/TROUBLESHOOTING.md`](https://github.com/hashicorp/terraform-ls/tree/main/docs/TROUBLESHOOTING.md). + + Debug output may contain sensitive information. Please review it before posting publicly, and if you are concerned, feel free to encrypt the files using [HashiCorp's GPG public key](https://www.hashicorp.com/security#secure-communications). + placeholder: | + https://gist.github.com/gdb/b6365e79be6052e7531e7ba6ea8caf23 + validations: + required: false + + - type: textarea + id: workarounds + attributes: + label: Workarounds + description: | + Did you discover any workarounds on your own? If so, please list them here. + validations: + required: false + + - type: textarea + id: references + attributes: + label: References + description: | + Are there any other GitHub issues (open or closed) or pull requests that relate to this issue? Or links to documentation pages? + Guide to referencing Github issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests + placeholder: | + - #123 + - #456 + - hashicorp/terraform#789 + - https://developer.hashicorp.com/terraform/language/expressions/dynamic-blocks + validations: + required: false + + - type: checkboxes + id: contribution + attributes: + label: Help Wanted + description: Is this something you're able to or interested in helping out with? This is not required but a helpful way to signal to us that you're planning to open a PR with a fix. + options: + - label: I'm interested in contributing a fix myself + required: false + + - type: textarea + id: community + attributes: + label: Community Note + description: Please do not remove, edit, or change the following note for our community. Just leave everything in this textbox as-is. + value: | + - Please 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 to help the community and maintainers prioritize this request + - 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 + - If you are interested in working on this issue or have submitted a pull request, please leave a comment + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 000000000..96fcf80ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,52 @@ +name: "Documentation issue or request" +description: "Report if something is incorrect in our docs, or suggest additions and improvements to our documentation" +labels: [documentation] +assignees: [] +body: + - type: markdown + attributes: + value: We use GitHub issues for tracking bugs and enhancements. For questions, please use [the community forum](https://discuss.hashicorp.com/c/terraform-core/terraform-editor-integrations/) where there are more people ready to help. + + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of the issue in plain English. + validations: + required: true + + - type: textarea + id: links + attributes: + label: Links + description: | + Include links to affected or related documentation page(s) or issues. + Guide to referencing Github issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests + placeholder: | + - https://github.com/hashicorp/terraform-ls/blob/main/docs/USAGE.md#emacs + - https://github.com/hashicorp/terraform-ls/blob/main/docs/features.md + - #123 + - #456 + validations: + required: true + + - type: checkboxes + id: contribution + attributes: + label: Help Wanted + description: Is this something you're able to or interested in helping out with? This is not required but a helpful way to signal to us that you're planning to open a PR with a fix. + options: + - label: I'm interested in contributing a fix myself + required: false + + - type: textarea + id: community + attributes: + label: Community Note + description: Please do not remove, edit, or change the following note for our community. Just leave everything in this textbox as-is. + value: | + - Please 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 to help the community and maintainers prioritize this request + - 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 + - If you are interested in working on this issue or have submitted a pull request, please leave a comment + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f4360894e..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -name: Feature request -about: Suggest a new feature or other enhancement. -labels: enhancement ---- - -### Current Version - -``` - -``` - -### Use-cases - - -### Attempted Solutions - - -### Proposal - - -### Related LSP methods - - -### References - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..7967a9ca5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,114 @@ +name: "Feature request" +description: "Suggest a new feature or other enhancement." +labels: [enhancement] +assignees: [] +body: + - type: markdown + attributes: + value: We use GitHub issues for tracking bugs and enhancements. For questions, please use [the community forum](https://discuss.hashicorp.com/c/terraform-core/terraform-editor-integrations/) where there are more people ready to help. + + - type: input + id: version + attributes: + label: Language Server Version + description: | + Run `terraform-ls --version` to show the version. + If you are not running the latest version, please try upgrading because your issue may have already been fixed. + placeholder: v0.31.2 + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: | + In order to properly evaluate a feature request, it is necessary to understand the use cases for it. + Please describe below the _end goal_ you are trying to achieve that has led you to request this feature. + Please keep this section focused on the problem and not on the suggested solution. We'll get to that in a moment, below! + + If you've already tried to solve the problem with existing features and found a limitation that prevented you from succeeding, please describe it below in as much detail as possible. + Ideally, this would include real configuration snippets that you tried, actions you performed (e.g. autocompletion in a particular position in that snippet), and what results you got in each case. + Please remove any sensitive information such as passwords before sharing configuration snippets. + placeholder: | + (I can do ... today but ...) + + When I do ... then ... + It would be helpful if ... + validations: + required: true + + - type: textarea + id: attempted + attributes: + label: Attempted Solutions + description: | + If you've already tried to solve the problem within server's existing features and found a limitation that prevented you from succeeding, please describe it below in as much detail as possible. + + Ideally, this would include real configuration snippets that you tried, actions you performed (e.g. autocompletion in a particular position in that snippet), and what results you got in each case. + + Please remove any sensitive information such as passwords before sharing configuration snippets and command lines. + validations: + required: false + + - type: textarea + id: proposal + attributes: + label: Proposal + description: | + If you have an idea for a way to address the problem via a change to existing features, please describe it below. + In this section, it's helpful to include specific examples of how what you are suggesting might look in configuration files, or on the command line, since that allows us to understand the full picture of what you are proposing. + If you're not sure of some details, don't worry! When we evaluate the feature request we may suggest modifications as necessary to work within the design constraints of the Language Server. + validations: + required: false + + - type: textarea + id: lsp + attributes: + label: Related LSP methods + description: | + Please mention if you know your request is related to any particular LSP method(s), e.g. `textDocument/completion`. + The specification with all methods is available at https://microsoft.github.io/language-server-protocol/specifications/specification-current/ + placeholder: | + - textDocument/completion + - textDocument/definition + - textDocument/hover + - textDocument/signatureHelp + validations: + required: false + + - type: textarea + id: references + attributes: + label: References + description: | + Are there any other GitHub issues (open or closed) or pull requests that relate to this request? Or links to documentation pages? + Guide to referencing Github issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests + placeholder: | + - #123 + - #456 + - hashicorp/terraform#789 + - https://developer.hashicorp.com/terraform/language/expressions/dynamic-blocks + validations: + required: false + + - type: checkboxes + id: contribution + attributes: + label: Help Wanted + description: Is this something you're able to or interested in helping out with? This is not required but a helpful way to signal to us that you're planning to open a PR with a fix. + options: + - label: I'm interested in contributing a fix myself + required: false + + - type: textarea + id: community + attributes: + label: Community Note + description: Please do not remove, edit, or change the following note for our community. Just leave everything in this textbox as-is. + value: | + - Please 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 to help the community and maintainers prioritize this request + - 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 + - If you are interested in working on this issue or have submitted a pull request, please leave a comment + validations: + required: true