From b0eb4edb567cf3d8de5d33c3bddbb18da0005bb3 Mon Sep 17 00:00:00 2001 From: "Stephen Lewis (Burrows)" Date: Tue, 30 Jan 2024 11:26:29 -0800 Subject: [PATCH] Fixed typos / formatting in bug issue form (#17133) --- .github/ISSUE_TEMPLATE/12_bug_test_form.yml | 27 +++++++-------------- 1 file changed, 9 insertions(+), 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/12_bug_test_form.yml b/.github/ISSUE_TEMPLATE/12_bug_test_form.yml index a3c99db1b10..2338ebe298e 100644 --- a/.github/ISSUE_TEMPLATE/12_bug_test_form.yml +++ b/.github/ISSUE_TEMPLATE/12_bug_test_form.yml @@ -21,17 +21,15 @@ body: attributes: label: Terraform Version description: | - Please run [`terraform version`](https://developer.hashicorp.com/terraform/cli/commands/version) to show - the Terraform core version and provider version(s) and past the output here. - If you are not running the latest version of Terraform or the provider, please upgrade - because your issue may have already been fixed. + Please run [`terraform version`](https://developer.hashicorp.com/terraform/cli/commands/version) to show the Terraform core version and provider version(s) and paste the output here. + If you are not running the latest version of Terraform or the provider, please upgrade because your issue may have already been fixed. validations: required: true - type: textarea id: affected-resources attributes: label: Affected Resource(s) - description: Please list the affected resources and data sources. Use google_* if all resources or data sources are affected. + description: Please list the affected resources and data sources. Use `google_*` if all resources or data sources are affected. validations: required: true - type: textarea @@ -41,12 +39,10 @@ body: description: | Copy-paste your Terraform configurations here as [markdown code blocks](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code). - For large Terraform configs, please use a service like Dropbox and share a link to the ZIP file. - For security, you can also encrypt the files using our GPG public key: - https://www.hashicorp.com/security + For large Terraform configs, please use a service like Dropbox and share a link to the ZIP file. For security, you can also encrypt the files using our GPG public key: https://www.hashicorp.com/security + + If reproducing the bug involves modifying the config file (that is, apply a config, change a value, apply the config again, see the bug), then please include both: - If reproducing the bug involves modifying the config file (e.g., apply a config, - change a value, apply the config again, see the bug), then please include both: * the version of the config before the change, and * the version of the config after the change. value: | @@ -57,9 +53,7 @@ body: attributes: label: Debug Output description: | - Please provide a link to a GitHub Gist containing your complete - [debug output]((https://www.terraform.io/docs/internals/debugging.html). Please do NOT - paste the debug output in the issue; just paste a link to the Gist. + Please provide a link to a GitHub Gist containing your complete [debug output](https://www.terraform.io/docs/internals/debugging.html). Please **don't** paste the debug output in the issue; just paste a link to the Gist. - type: textarea id: expected-behavior attributes: @@ -81,13 +75,10 @@ body: attributes: label: Important Factoids description: | - Is there anything atypical about your accounts that we should know? For example: authenticating - as a user instead of a service account? + Is there anything atypical about your accounts that we should know? For example: authenticating as a user instead of a service account? - type: textarea id: references attributes: label: References description: | - Are there any other GitHub issues (open or closed) or pull requests that should be - [linked](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) - here? Vendor documentation? + Are there any other GitHub issues (open or closed) or pull requests that should be [linked](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) here? Vendor documentation?