From 053b3c8e40244780b1cb0817d69ffea41dc5cf5a Mon Sep 17 00:00:00 2001 From: Joel Fischer Date: Thu, 27 Jan 2022 14:29:01 -0500 Subject: [PATCH] Add Github issue forms --- .github/ISSUE_TEMPLATE.md | 23 ------- .github/ISSUE_TEMPLATE/best-practice.yml | 16 +++++ .github/ISSUE_TEMPLATE/bug-report.yml | 67 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/internal-proposal.yml | 36 +++++++++++ 5 files changed, 120 insertions(+), 23 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/best-practice.yml create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/internal-proposal.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index ccc8001c9..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,23 +0,0 @@ -[Delete any non-applicable sections, but we may ask for more information. Please reference the [SmartDeviceLink GitHub Best Practices](https://d83tozu1c8tt6.cloudfront.net/media/resources/SDL_GitHub_BestPractices.pdf) for further instructions on how to enter an issue.] - -### Bug Report -[Summary] - -##### Reproduction Steps -1. [Step 1] -2. [Step 2] -3. [Step 3] - -##### Expected Behavior -[Some expected behavior] - -##### Observed Behavior -[Some observed behavior] - -##### OS & Version Information -* iOS Version: [What version of iOS are you using when the bug occurred] -* SDL iOS Version: [What version of the library has this bug been seen on] -* Testing Against: [What you tested with to observe this behavior] - -##### Test Case, Sample Code, and / or Example App -[Paste a link to a PR, gist, or other code that exemplifies this behavior] diff --git a/.github/ISSUE_TEMPLATE/best-practice.yml b/.github/ISSUE_TEMPLATE/best-practice.yml new file mode 100644 index 000000000..e947c1ea0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/best-practice.yml @@ -0,0 +1,16 @@ +name: Best Practice +description: Report a best practice issue, such as a language feature or README update. +labels: ["needs triage", "best practice"] +body: + - type: markdown + attributes: + value: | + ## Hello 👋 + If this issue involves a defect with the library, please file a Bug Report issue instead. If this is an issue with a recommended README / documentation update or a language update. + - type: textarea + id: summary + attributes: + label: Description + description: Summarize the problem. Attach any relevant links or + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..6d429e808 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,67 @@ +name: Bug Report +description: File a bug report +labels: ["needs triage", "bug"] +body: + - type: markdown + attributes: + value: | + ## Hello 👋 + Thank you for filling out a bug report. We'll respond as quickly as we can. The more information you provide, the more likely we are to be able to diagnose the problem. If you have something else to discuss that doesn't fit this template, try our [Slack](https://slack.smartdevicelink.com/). + - type: textarea + id: summary + attributes: + label: Bug Summary + description: Summarize the problem. Attach any relevant crash reports or test apps as well. + validations: + required: true + - type: textarea + id: repro-steps + attributes: + label: Reproduction Steps + value: | + 1. [Step 1] + 2. [Step 2] + 3. [Step 3] + + Expected Behavior: + + Observed Behavior: + validations: + required: true + - type: input + id: ios-version + attributes: + label: iOS Version(s) + placeholder: 15.1.3 + validations: + required: false + - type: input + id: sdl-ios-version + attributes: + label: sdl_ios Version + placeholder: 7.3.0 + validations: + required: true + - type: textarea + id: testing-against + attributes: + label: Testing Environment(s) + description: | + For Example: + - Ford TDK 3.4 (19286_DEVTEST) + - Manticore v2.9.0 (See top of the open Manticore screen) + - SDL Core v8.0.0 + Generic_HMI v0.11.0 + placeholder: | + For Example: + - Ford TDK 3.4 (19286_DEVTEST) + - Manticore v2.9.0 (See top of the open Manticore screen) + - SDL Core v8.0.0 + Generic_HMI v0.11.0 + render: markdown + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy-paste any relevant log output. This will automatically be rendered as code. + render: shell \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..3ba13e0ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/internal-proposal.yml b/.github/ISSUE_TEMPLATE/internal-proposal.yml new file mode 100644 index 000000000..773723d48 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/internal-proposal.yml @@ -0,0 +1,36 @@ +name: Proposal (For Livio Internal Use ONLY) +description: Create a proposal feature issue +title: "[SDL XXXX] TITLE" +labels: proposal +body: + - type: markdown + attributes: + value: | + ## Hello 👋 + If you are not a Livio project manager, this is not the template for you. This is intended to be a template for creating an issue based on an accepted proposal from the [SDL Evolution](https://www.github.com/smartdevicelink/sdl_evolution) process. + - type: textarea + id: proposal-link + attributes: + label: Proposal Link + value: | + Proposal: [Proposal Name](Proposal Link) + render: markdown + validations: + required: true + - type: textarea + id: proposal-description + attributes: + label: Proposal Introduction + value: | + > Paste proposal introduction here + render: markdown + validations: + required: true + - type: input + id: review-link + attributes: + label: Review Link + value: | + Review: Paste Proposal Review Link Here + validations: + required: true \ No newline at end of file