From 130b0f8e4a5e6e1e2a23e6ea7fa9537ccbe6f767 Mon Sep 17 00:00:00 2001 From: Jacob Riddle <87780794+jriddle-linode@users.noreply.github.com> Date: Fri, 24 Sep 2021 10:01:12 -0400 Subject: [PATCH] Update Issue Templates to Forms (#220) * Add forms for various types of issues --- .github/ISSUE_TEMPLATE.md | 33 ------------------ .github/ISSUE_TEMPLATE/bug.yml | 48 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/enhancement.yml | 21 +++++++++++ .github/ISSUE_TEMPLATE/help.yml | 21 +++++++++++ .github/labels.yml | 4 ++- 5 files changed, 93 insertions(+), 34 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml create mode 100644 .github/ISSUE_TEMPLATE/help.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index d2baea34d..5855f6e18 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,34 +1 @@ -## General: - -* [ ] Have you removed all sensitive information, including but not limited to access keys and passwords? -* [ ] Have you checked to ensure there aren't other open or closed [Pull Requests](../../pulls) for the same bug/feature/question? - ----- - -## Feature Requests: -* [ ] Have you explained your rationale for why this feature is needed? -* [ ] Have you offered a proposed implementation/solution? - ----- - -## Bug Reporting - -### Expected Behavior - -### Actual Behavior - -### Steps to Reproduce the Problem - - 1. - 1. - 1. - -### Environment Specifications - -#### Screenshots, Code Blocks, and Logs - -#### Additional Notes - ----- - The [Linode Community](https://www.linode.com/community/questions/) is a great place to get additional support. diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..46f016a3e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,48 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug"] +body: + - type: input + id: go-version + attributes: + label: go Version + description: What version of go are you running? `go version` + placeholder: go version go1.17.1 linux/amd64 + validations: + required: true + - type: input + id: linodego-version + attributes: + label: API Wrapper Version + description: What version of our wrapper are you running? + placeholder: github.com/linode/linodego v1.0.0 + validations: + required: true + - type: textarea + id: code + attributes: + render: go + label: Code Snippet + description: If your files are too long for a short code snippet please use GitHub Gists + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What should have happened? + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to Reproduce + description: List any custom configurations and the steps to reproduce this error + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 000000000..13bf20863 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,21 @@ +name: Enhancement +description: Request a feature +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: textarea + id: description + attributes: + label: Description + description: What would you like this feature to do in detail? + validations: + required: true + - type: textarea + id: example + attributes: + label: Example Code + description: How would you use this feature in some example code? + placeholder: | + ```go + var := linodego.NewFeature() + ``` diff --git a/.github/ISSUE_TEMPLATE/help.yml b/.github/ISSUE_TEMPLATE/help.yml new file mode 100644 index 000000000..09af86b09 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/help.yml @@ -0,0 +1,21 @@ +name: Help +description: You're pretty sure it's not a bug but you can't figure out why it's not working +title: "[Help]: " +labels: ["help wanted"] +body: + - type: textarea + id: description + attributes: + label: Description + description: What would you like this feature to do in detail? + validations: + required: true + - type: textarea + id: example + attributes: + label: Example Code + description: How would you use this feature in some example code? + placeholder: | + ```go + var := linodego.NewFeature() + ``` diff --git a/.github/labels.yml b/.github/labels.yml index adb4c043c..42f630aee 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -25,4 +25,6 @@ - name: good first issue description: Low hanging fruit. color: 7057ff - +- name: help wanted + description: I need some help. + color: 008672