Added issue templates and links (#223)

* Added issue templates and links * Update .github/workflows/ISSUE_TEMPLATE/config.yml Co-authored-by: Michael Hawker MSFT (XAML Llama) <24302614+michael-hawker@users.noreply.github.com> * Update .github/workflows/ISSUE_TEMPLATE/config.yml Co-authored-by: Michael Hawker MSFT (XAML Llama) <24302614+michael-hawker@users.noreply.github.com> * Update .github/workflows/ISSUE_TEMPLATE/config.yml Co-authored-by: Michael Hawker MSFT (XAML Llama) <24302614+michael-hawker@users.noreply.github.com> * Organize, add Maui, Uno and Wasdk links * Add missing SDKs and Windows Build Numbers * Update Uno/Wasdk about * Add PR template * Moved WindowsAppSDK * Clarified ticket req and feature migration * Updated repro guidance --------- Co-authored-by: Michael Hawker MSFT (XAML Llama) <24302614+michael-hawker@users.noreply.github.com>
CommunityToolkit · Sep 7, 2023 · 81f14f1 · 81f14f1
1 parent a7354d6
commit 81f14f1
Show file tree

Hide file tree

Showing 3 changed files with 230 additions and 0 deletions.
diff --git a/.github/workflows/ISSUE_TEMPLATE/bug.yml b/.github/workflows/ISSUE_TEMPLATE/bug.yml
@@ -0,0 +1,146 @@
+name: Bug report
+description: Create a report to help us fix something within the Windows Community Toolkit.
+labels: ["bug :bug:"]
+body:
+- type: markdown
+  attributes: 
+    value: |
+      ## Before you begin
+      🚨 **Please do not skip instructions**🚨
+      
+      This info is essential for investigating your bug report. Issues with missing information may be closed without investigation.
+      
+      If you're uncertain about a problem, find or start a [Questions & Answers](https://github.com/CommunityToolkit/Windows/discussions/categories/q-a) discussion, where you can get insight from the community regarding your issue.       
+- type: textarea
+  id: description
+  validations:
+    required: true
+  attributes:
+     label: Describe the bug
+     description: A clear and concise description of what the bug is.
+- type: textarea
+  id: repro-steps
+  validations:
+    required: true
+  attributes:
+     label: Steps to reproduce
+     render: text
+     description: Provide steps to reproduce the issue, or let us know why it can't be reproduced (e.g. more complex setup, environment, dependencies, etc...)
+     placeholder: |
+        The easier we can reproduce the issue, the easier it is to understand and fix the problem. 
+        Provide repro steps, code-snippets, or a standalone project to help us understand the issue you're facing.
+        
+        If the problem can be reproduced in our [Sample Gallery](https://aka.ms/windowstoolkitapp), you can speed up creation of a functional repro by forking the toolkit and adding or modifying a test or sample. Link to the forked repo and branch.
+
+        Example repro steps:
+        1. Given the following environment (Sample App w/ XAML, Project with Isolated setup, etc...)
+        2. Go to '...'
+        3. Click on '....'
+        4. Scroll down to '....'
+        5. See error
+- type: textarea
+  id: expected-behavior
+  validations:
+    required: true
+  attributes:
+     label: Expected behavior
+     description: A clear and concise description of what you expected to happen.
+- type: textarea
+  id: screenshots
+  attributes:
+     label: Screenshots
+     description: If applicable, add screenshots to help explain your problem.
+- type: checkboxes
+  id: platform
+  attributes:
+    label: Code Platform
+    description: Check the platforms where you see the issue occur.
+    options:
+      - label: UWP
+      - label: WinAppSDK / WinUI 3
+      - label: Web Assembly (WASM)
+      - label: Android
+      - label: iOS
+      - label: MacOS
+      - label: Linux / GTK
+- type: checkboxes
+  id: environment-windows-build
+  attributes:
+     label: Windows Build Number
+     description: Check one or more of the following options (if applicable)
+     options:
+       - label: Windows 10 1809 (Build 17763)
+       - label: Windows 10 1903 (Build 18362)
+       - label: Windows 10 1909 (Build 18363)
+       - label: Windows 10 2004 (Build 19041)
+       - label: Windows 10 20H2 (Build 19042)
+       - label: Windows 10 21H1 (Build 19043)
+       - label: Windows 10 21H2 (Build 19044)
+       - label: Windows 10 22H2 (Build 19045)
+       - label: Windows 11 21H2 (Build 22000)
+       - label: Other (specify)
+- type: input
+  id: environment-windows-build-other-build-number
+  attributes:
+     label: Other Windows Build number
+     description: If applicable, another Windows build number not listed (such as an Insider build)
+- type: checkboxes
+  id: environment-app-min-target-version
+  attributes:
+     label: App minimum and target SDK version
+     description: Check one or more of the following options
+     options:
+       - label: Windows 10, version 1809 (Build 17763)
+       - label: Windows 10, version 1903 (Build 18362)
+       - label: Windows 10, version 1909 (Build 18363)
+       - label: Windows 10, version 2004 (Build 19041)
+       - label: Windows 10, version 2104 (Build 20348)
+       - label: Windows 11, version 22H2 (Build 22000)
+       - label: Other (specify)
+- type: input
+  id: environment-app-min-target-other-build-number
+  attributes:
+     label: Other SDK version
+     description: If applicable, another SDK version not listed (such as an Insider SDK)
+- type: dropdown
+  id: visual-studio-version
+  attributes: 
+     multiple: true
+     label: Visual Studio Version
+     description: Check one or more of the following options
+     options:
+       - 2022
+       - Preview
+- type: input
+  id: visual-studio-exact-build
+  attributes:
+     label: Visual Studio Build Number
+     description: What's the exact build number? (Found in Visual Studio under Help -> About Microsoft Visual Studio)
+- type: dropdown
+  id: form-factor
+  attributes: 
+     multiple: true
+     label: Device form factor
+     description: Check one or more of the following options
+     options:
+       - Desktop
+       - Xbox
+       - Surface Hub
+       - IoT
+       - Mobile
+- type: textarea
+  id: additional-context
+  attributes:
+     label: Additional context
+     description: Add any other context about the problem here.
+- type: dropdown
+  id: contribution
+  validations:
+    required: true
+  attributes:
+     label: Help us help you
+     description: Would you like to contribute a solution to this issue?
+     options:
+       - Yes, I'd like to be assigned to work on this item.
+       - Yes, but only if others can assist.
+       - No, I'm unable to contribute a solution.
diff --git a/.github/workflows/ISSUE_TEMPLATE/config.yml b/.github/workflows/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,23 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Questions about the Toolkit?
+    url: https://github.com/CommunityToolkit/Windows/discussions/categories/q-a
+    about: I have a question about how to use something in the toolkit.
+  - name: New Idea?
+    url: https://github.com/CommunityToolkit/Labs-Windows/discussions?discussions_q=category%3AExperiments+category%3AIdeas+category%3AProposals
+    about: Labs is where we propose and experiment with new ideas. Search ongoing experiments or contribute your own!
+  - name: MVVM Toolkit, High Performance, or Diagnostic Package 
+    url: https://aka.ms/toolkit/dotnet
+    about: "If you have a question on these, see the .NET Community Toolkit repo:"
+  - name: MAUI Community Toolkit
+    url: https://aka.ms/toolkit/maui
+    about: "This repository is for the Windows Community Toolkit. For MAUI, see the MAUI Community Toolkit repo:"
+  - name: WindowsAppSDK
+    url: https://aka.ms/windowsappsdk
+    about: "This repository is for the Windows Community Toolkit, for issues in the platform itself, see the WindowsAppSDK repo:"
+  - name: Cross-platform / Uno Platform
+    url: https://github.com/unoplatform/uno
+    about: "The Windows Community Toolkit uses Uno Platform for cross-platform WinUI. See the Uno Platform repo for issues specific to running on non-Windows platforms:"
+  - name: Discord
+    url: https://aka.ms/wct/discord
+    about: "Join the UWP Discord Server and talk to us in the #community-toolkit channel."
diff --git a/.github/workflows/PULL_REQUEST_TEMPLATE.md b/.github/workflows/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,61 @@
+<!-- 🚨 Please Do Not skip any instructions and information mentioned below as they are all required and essential to evaluate and test the PR. By fulfilling all the required information you will be able to reduce the volume of questions and most likely help merge the PR faster 🚨 -->
+
+<!-- ⚠ We will not merge the PR to the main repo if your changes are not in a *feature branch* of your forked repository. Create a new branch in your repo, **do not use the `main` branch in your repo**! ⚠ -->
+
+<!-- 👉 It is imperative to resolve ONE ISSUE PER PR and avoid making multiple changes unless the changes interrelate with each other -->
+
+<!-- 📝 Please always keep the "☑️ Allow edits by maintainers" button checked in the Pull Request Template as it increases collaboration with the Toolkit maintainers by permitting commits to your PR branch (only) created from your fork. This can let us quickly make fixes for minor typos or forgotten StyleCop issues during review without needing to wait on you doing extra work. Let us help you help us! 🎉 -->
+
+## Fixes
+
+<!-- Add the relevant issue number after the word "Fixes" mentioned above (for ex: `## Fixes #0000`) which will automatically close the issue once the PR is merged. -->
+
+<!-- PRs without assigned issues will be closed unless minor changes to documentation/typos. -->
+
+<!-- Add a brief overview here of the feature/bug & fix. -->
+
+## PR Type
+
+What kind of change does this PR introduce?
+
+<!-- Please uncomment one or more options below that apply to this PR. -->
+<!-- New features should come from Windows Community Toolkit Labs. If you're migrating a component from Labs, link to the approval comment here. -->
+
+<!-- - Bugfix -->
+<!-- - Code style update (formatting) -->
+<!-- - Refactoring (no functional changes, no api changes) -->
+<!-- - Build or CI related changes -->
+<!-- - Documentation content changes -->
+<!-- - Sample app changes -->
+<!-- - Other... Please describe: -->
+
+## What is the current behavior?
+
+<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
+
+## What is the new behavior?
+
+<!-- Describe how was this issue resolved or changed? -->
+
+## PR Checklist
+
+Please check if your PR fulfills the following requirements: <!-- and remove the ones that are not applicable to the current PR -->
+
+- [ ] Created a feature/dev branch in your fork (vs. submitting directly from a commit on main)
+- [ ] Based off latest main branch of toolkit
+- [ ] Tested code with current supported SDKs
+- [ ] New component
+  - [ ] Documentation has been added
+  - [ ] Sample in sample app has been added
+  - [ ] Analyzers are passing for documentation and samples
+  - [ ] Icon has been created (if new sample) following the [Thumbnail Style Guide and templates](https://github.com/CommunityToolkit/WindowsCommunityToolkit-design-assets)
+- [ ] Tests for the changes have been added (if applicable)
+- [ ] Header has been added to all new source files
+- [ ] Contains **NO** breaking changes
+
+<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below.
+Please note that breaking changes are likely to be rejected within minor release cycles or held until major versions. -->
+
+## Other information
+
+<!-- Please add any other information that might be helpful to reviewers. -->