-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
.github: Add issue templates and selector
So we can triage incoming issues better.
- Loading branch information
Showing
3 changed files
with
156 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| name: Bug Report | ||
| description: Something is incorrect or not working as expected. | ||
| labels: ["bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for taking the time to fill out this bug report! Please note that this issue tracker is only used for bug reports and feature requests. Other issues will be closed. | ||
| If you have a configuration, workflow, or other question, please go back to the issue chooser and select one of the question links. | ||
| - type: textarea | ||
| id: versions | ||
| attributes: | ||
| label: Terraform CLI and terraform-plugin-docs Versions | ||
| description: What versions of Terraform CLI and tfplugindocs? | ||
| placeholder: Output of `terraform version` and `tfplugindocs --version` from provider code directory | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: provider-code | ||
| attributes: | ||
| label: Provider Code | ||
| description: Please copy and paste any relevant provider code. This will be automatically formatted into code, so no need for backticks. | ||
| render: go | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected Behavior | ||
| description: What did you expect to happen? | ||
| placeholder: Description of what should have happened. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: actual-behavior | ||
| attributes: | ||
| label: Actual Behavior | ||
| description: What actually happened? | ||
| placeholder: Description of what actually happened. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: reproduction-steps | ||
| attributes: | ||
| label: Steps to Reproduce | ||
| description: List of steps to reproduce the issue. | ||
| value: | | ||
| 1. `tfplugindocs generate --flags` | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: impact | ||
| attributes: | ||
| label: How much impact is this issue causing? | ||
| description: High represents completely not able to use the tool and no workaround. Medium represents an issue with potential workaround. Low represents documentation or minor tooling behavior issues. | ||
| options: | ||
| - Low | ||
| - Medium | ||
| - High | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: logs | ||
| attributes: | ||
| label: Logs | ||
| description: If the command output is very long, please provide a link to a [GitHub Gist](https://gist.github.com) containing the full output. | ||
| placeholder: https://gist.github.com/example/12345678 | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: additional-information | ||
| attributes: | ||
| label: Additional Information | ||
| description: Are there any additional details about your environment, workflow, or recent changes that might be relevant? Have you discovered a workaround? Are there links to other related issues? | ||
| validations: | ||
| required: false | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Community Guidelines](https://www.hashicorp.com/community-guidelines). | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| name: Feature Request | ||
| description: Something is missing or could be improved. | ||
| labels: ["enhancement"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for taking the time to fill out this feature request! Please note that this issue tracker is only used for bug reports and feature requests. Other issues will be closed. | ||
| If you have a configuration, workflow, or other question, please go back to the issue chooser and select one of the question links. | ||
| - type: textarea | ||
| id: versions | ||
| attributes: | ||
| label: Terraform CLI and terraform-plugin-docs Versions | ||
| description: What versions of Terraform CLI and tfplugindocs? | ||
| placeholder: Output of `terraform version` and `tfplugindocs --version` from provider code directory | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: use-case | ||
| attributes: | ||
| label: Use Cases or Problem Statement | ||
| description: What use cases or problems are you trying to solve? | ||
| placeholder: Description of use cases or problems. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: proposal | ||
| attributes: | ||
| label: Proposal | ||
| description: What solutions would you prefer? | ||
| placeholder: Description of proposed solutions. | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: impact | ||
| attributes: | ||
| label: How much impact is this issue causing? | ||
| description: High represents completely not able to use the tool and no workaround. Medium represents an issue with potential workaround. Low represents documentation or minor tooling behavior issues. | ||
| options: | ||
| - Low | ||
| - Medium | ||
| - High | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-information | ||
| attributes: | ||
| label: Additional Information | ||
| description: Are there any additional details about your environment, workflow, or recent changes that might be relevant? Have you discovered a workaround? Are there links to other related issues? | ||
| validations: | ||
| required: false | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Community Guidelines](https://www.hashicorp.com/community-guidelines). | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Provider-related Feedback and Questions | ||
| url: https://registry.terraform.io/browse/providers | ||
| about: Each Terraform Provider (e.g. AWS, AzureRM, GCP, Kubernetes, etc.) has its own issue tracker and any provider specific feedback should be directed to appropriate provider repository. | ||
| - name: Terraform Language or Workflow Feedback and Questions | ||
| url: https://github.com/hashicorp/terraform/issues/new/choose | ||
| about: Terraform Core has its own repository, any language (HCL) or workflow related issues or questions should be directed there. | ||
| - name: Provider Development Questions | ||
| url: https://discuss.hashicorp.com/c/terraform-providers/tf-plugin-sdk | ||
| about: Please ask and answer provider development questions in HashiCorp Discuss. |