From 82f1e5f05ef0c556850a53c21ef0392ca5fb28b7 Mon Sep 17 00:00:00 2001 From: "Kent C. Dodds" Date: Wed, 29 May 2024 11:57:11 -0600 Subject: [PATCH] docs: add ts and prettier templates --- .../DISCUSSION_TEMPLATE/eslint-suggestion.yml | 4 +- .../prettier-suggestion.yml | 69 +++++++++++++++++++ .../typescript-suggestion.yml | 55 +++++++++++++++ 3 files changed, 126 insertions(+), 2 deletions(-) create mode 100644 .github/DISCUSSION_TEMPLATE/prettier-suggestion.yml create mode 100644 .github/DISCUSSION_TEMPLATE/typescript-suggestion.yml diff --git a/.github/DISCUSSION_TEMPLATE/eslint-suggestion.yml b/.github/DISCUSSION_TEMPLATE/eslint-suggestion.yml index 5adfe48..127a507 100644 --- a/.github/DISCUSSION_TEMPLATE/eslint-suggestion.yml +++ b/.github/DISCUSSION_TEMPLATE/eslint-suggestion.yml @@ -20,8 +20,8 @@ body: attributes: label: Search Terms Used description: >- - Please list the search terms you used to search the issues and PRs - before submitting this issue. + Please list the search terms you used to search the discussions, issues, + and PRs before submitting this issue. validations: required: true - type: input diff --git a/.github/DISCUSSION_TEMPLATE/prettier-suggestion.yml b/.github/DISCUSSION_TEMPLATE/prettier-suggestion.yml new file mode 100644 index 0000000..c3d633b --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/prettier-suggestion.yml @@ -0,0 +1,69 @@ +body: + - type: markdown + attributes: + value: |- + Thank you for helping to improve `@epic-web/config`! + + Please fill out the details below. + + Keep in mind you can always extend the built-in configuration with your own config. + - type: textarea + attributes: + label: Search Terms Used + description: >- + Please list the search terms you used to search the discussions, issues, + and PRs before submitting this issue. + validations: + required: true + - type: input + attributes: + label: Config Docs + description: >- + Link to the documentation for the config option you're suggesting + changing + placeholder: https://prettier.io/docs/en/options#jsx-quotes + validations: + required: true + - type: textarea + attributes: + label: Suggested Change + description: >- + Write out the suggested change in configuration. If the config is + already present, explain why it should be removed or changed. If it's + not present, explain why it should be added. And provide the final + configuration for the option. + validations: + required: true + - type: textarea + attributes: + label: Code format before the change + description: >- + Show me examples of what code looks like before this change. + validations: + required: true + - type: textarea + attributes: + label: Code format after the change + description: >- + Show me examples of what code looks like after this change. + validations: + required: true + - type: textarea + attributes: + label: Issues without the change + description: >- + Convince me why life is better with this change. + validations: + required: true + - type: textarea + attributes: + label: Severity of inaction + description: Convince me why not doing anything is bad. + validations: + required: true + - type: textarea + attributes: + label: Additional Context + description: Any other context that could be helpful. + validations: + required: false diff --git a/.github/DISCUSSION_TEMPLATE/typescript-suggestion.yml b/.github/DISCUSSION_TEMPLATE/typescript-suggestion.yml new file mode 100644 index 0000000..a853b40 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/typescript-suggestion.yml @@ -0,0 +1,55 @@ +body: + - type: markdown + attributes: + value: |- + Thank you for helping to improve `@epic-web/config`! + + Please fill out the details below. + + Keep in mind you can always extend the built-in configuration with your own config. + - type: textarea + attributes: + label: Search Terms Used + description: >- + Please list the search terms you used to search the discussions, issues, + and PRs before submitting this issue. + validations: + required: true + - type: input + attributes: + label: Config Docs + description: >- + Link to the documentation for the config option you're suggesting + changing + placeholder: https://www.typescriptlang.org/tsconfig/#noImplicitThis + validations: + required: true + - type: textarea + attributes: + label: Suggested Change + description: >- + Write out the suggested change in configuration. If the config is + already present, explain why it should be removed or changed. If it's + not present, explain why it should be added. And provide the final + configuration for the option. + validations: + required: true + - type: textarea + attributes: + label: Issues without the change + description: >- + Convince me why life is better with this change. + validations: + required: true + - type: textarea + attributes: + label: Severity of inaction + description: Convince me why not doing anything is bad. + validations: + required: true + - type: textarea + attributes: + label: Additional Context + description: Any other context that could be helpful. + validations: + required: false