Skip to content

Commit ed6bd23

Browse files
authored
Merge pull request #209 from CommunityToolkit/llama/github-templates
Add GitHub Templates
2 parents 2fc52f8 + cc73386 commit ed6bd23

File tree

3 files changed

+275
-0
lines changed

3 files changed

+275
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
name: Bug report (Labs Infrastructure)
2+
description: Create a report to help us fix something within labs itself (for specific components - comment on the Experiment's issue)
3+
labels: ["bug :bug:"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Before you begin
9+
🚨 **Please do not skip instructions**🚨
10+
11+
This info is essential for investigating your bug report. Issues with missing information may be closed without investigation.
12+
13+
If you're uncertain about a problem, find or start a [Questions & Answers](https://github.com/CommunityToolkit/Labs-Windows/discussions/categories/q-a) discussion, where you can get insight from the community regarding your issue.
14+
15+
This form is for reporting issues with the Labs infrastructure, template, or Sample app itself and not individual experiments.
16+
17+
If you have an issue about a specific **Experiment**, please find it's issue and comment there.
18+
19+
- type: textarea
20+
id: description
21+
validations:
22+
required: true
23+
attributes:
24+
label: Describe the bug
25+
description: A clear and concise description of what the bug is.
26+
- type: textarea
27+
id: repro-steps
28+
validations:
29+
required: true
30+
attributes:
31+
label: Steps to reproduce
32+
render: text
33+
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...)
34+
placeholder: |
35+
A repro from the sample app expedites the process of discovering, resolving, and validating bug fixes.
36+
Provide code-snippets or XAML snippets as appropriate.
37+
38+
Example repro steps:
39+
1. Given the following environment (Sample App w/ XAML, Project with Isolated setup, etc...)
40+
2. Go to '...'
41+
3. Click on '....'
42+
4. Scroll down to '....'
43+
5. See error
44+
- type: textarea
45+
id: expected-behavior
46+
validations:
47+
required: true
48+
attributes:
49+
label: Expected behavior
50+
description: A clear and concise description of what you expected to happen.
51+
- type: textarea
52+
id: screenshots
53+
attributes:
54+
label: Screenshots
55+
description: If applicable, add screenshots to help explain your problem.
56+
- type: checkboxes
57+
id: platform
58+
attributes:
59+
label: Code Platform
60+
description: Check the platforms where you see the issue occur.
61+
options:
62+
- label: UWP
63+
- label: WinAppSDK / WinUI 3
64+
- label: Web Assembly (WASM)
65+
- label: Android
66+
- label: iOS
67+
- label: MacOS
68+
- label: Linux / GTK
69+
- type: checkboxes
70+
id: environment-windows-build
71+
attributes:
72+
label: Windows Build Number
73+
description: Check one or more of the following options (if applicable)
74+
options:
75+
- label: Windows 10 1809 (Build 17763)
76+
- label: Windows 10 1903 (Build 18362)
77+
- label: Windows 10 1909 (Build 18363)
78+
- label: Windows 10 2004 (Build 19041)
79+
- label: Windows 10 20H2 (Build 19042)
80+
- label: Windows 10 21H1 (Build 19043)
81+
- label: Windows 11 21H2 (Build 22000)
82+
- label: Other (specify)
83+
- type: input
84+
id: environment-windows-build-other-build-number
85+
attributes:
86+
label: Other Windows Build number
87+
description: If applicable, another Windows build number not listed (such as an Insider build)
88+
- type: checkboxes
89+
id: environment-app-min-target-version
90+
attributes:
91+
label: App minimum and target SDK version
92+
description: Check one or more of the following options
93+
options:
94+
- label: Windows 10, version 1809 (Build 17763)
95+
- label: Windows 10, version 1903 (Build 18362)
96+
- label: Windows 10, version 1909 (Build 18363)
97+
- label: Windows 10, version 2004 (Build 19041)
98+
- label: Other (specify)
99+
- type: input
100+
id: environment-app-min-target-other-build-number
101+
attributes:
102+
label: Other SDK version
103+
description: If applicable, another SDK version not listed (such as an Insider SDK)
104+
- type: dropdown
105+
id: visual-studio-version
106+
attributes:
107+
multiple: true
108+
label: Visual Studio Version
109+
description: Check one or more of the following options
110+
options:
111+
- 2022
112+
- Preview
113+
- type: input
114+
id: visual-studio-exact-build
115+
attributes:
116+
label: Visual Studio Build Number
117+
description: What's the exact build number? (Found in Visual Studio under Help -> About Microsoft Visual Studio)
118+
- type: dropdown
119+
id: form-factor
120+
attributes:
121+
multiple: true
122+
label: Device form factor
123+
description: Check one or more of the following options
124+
options:
125+
- Desktop
126+
- Xbox
127+
- Surface Hub
128+
- IoT
129+
- Mobile
130+
- type: textarea
131+
id: additional-context
132+
attributes:
133+
label: Additional context
134+
description: Add any other context about the problem here.
135+
- type: dropdown
136+
id: contribution
137+
validations:
138+
required: true
139+
attributes:
140+
label: Help us help you
141+
description: Would you like to contribute a solution to this issue?
142+
options:
143+
- Yes, I'd like to be assigned to work on this item.
144+
- Yes, but only if others can assist.
145+
- No, I'm unable to contribute a solution.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Issue with Existing Experiment
4+
url: https://github.com/CommunityToolkit/Labs-Windows/issues?q=is%3Aopen+is%3Aissue+label%3A%22experiment+%3Atest_tube%3A%22
5+
about: Please comment on existing Experiment issues with any problems which arise during their use.
6+
- name: New Idea?
7+
url: https://github.com/CommunityToolkit/Labs-Windows/discussions?discussions_q=category%3AExperiments+category%3AIdeas
8+
about: Search existing experiments and ideas or contribute your own in our Discussion forum.
9+
- name: Not sure where to start? Start a Discussion!
10+
url: https://github.com/CommunityToolkit/Labs-Windows/discussions
11+
about: I have a question about how to use something in the toolkit.
12+
- name: Discord
13+
url: https://aka.ms/wct/discord
14+
about: "Join the UWP Discord Server and talk to us in the #community-toolkit channel."
15+
- name: Toolkit Questions
16+
url: https://github.com/CommunityToolkit/WindowsCommunityToolkit/discussions/categories/questions-help
17+
about: If you have general questions about how to use something in the toolkit, outside of Labs, see the main repo discussions.

.github/ISSUE_TEMPLATE/experiment.yml

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
name: Experiment Tracking Form
2+
description: (w/ Approved Discussion) Create an issue to track an approved experiment
3+
title: "🧪 [Experiment]"
4+
labels: ["experiment :test_tube:"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Before you begin
10+
🚨 **Please do not skip instructions**🚨
11+
12+
This template is to be used with an approved experiment proposal in the [Discussions](https://github.com/CommunityToolkit/Labs-Windows/discussions).
13+
14+
This info is essential to help us process your experiment.
15+
16+
- type: input
17+
id: linked-discussion
18+
validations:
19+
required: true
20+
attributes:
21+
label: Approved from Discussion
22+
description: Paste in a link to your approved discussion from https://github.com/CommunityToolkit/Labs-Windows/discussions
23+
placeholder: "https://github.com/CommunityToolkit/Labs-Windows/discussions/###"
24+
25+
- type: textarea
26+
id: problem-statement
27+
validations:
28+
required: true
29+
attributes:
30+
label: Problem Statement
31+
description: Copy your problem statement description from your approved discussion.
32+
placeholder: |
33+
A clear and concise description of what the problem the experiment solves, starting with the user story.
34+
35+
- type: textarea
36+
id: overview-description
37+
validations:
38+
required: true
39+
attributes:
40+
label: Overview
41+
description: What components/functions does this experiment add?
42+
value: |
43+
This experiment adds the following components:
44+
- **Component One** a ...
45+
- **Component Two** a ...
46+
47+
- type: textarea
48+
id: using-links
49+
validations:
50+
required: true
51+
attributes:
52+
label: Using
53+
description: Describe how to try out your component
54+
value: |
55+
You can try it out via the NuGet Packages here:
56+
- UWP: https://dev.azure.com/dotnet/CommunityToolkit/_artifacts/feed/CommunityToolkit-Labs/NuGet/CommunityToolkit.Labs.Uwp.ExperimentName/overview/0.0.1
57+
- WinUI 3: https://dev.azure.com/dotnet/CommunityToolkit/_artifacts/feed/CommunityToolkit-Labs/NuGet/CommunityToolkit.Labs.WinUI.ExperimentName/overview/0.0.1
58+
Read more about [Preview Packages here](https://aka.ms/wct/wiki/previewpackages).
59+
60+
- type: textarea
61+
id: additional-info
62+
attributes:
63+
label: Additional info
64+
description: Add any other context or screenshots about the feature request here.
65+
66+
- type: checkboxes
67+
id: implementation-requirements
68+
attributes:
69+
label: Implementation Requirements
70+
description: Not all these items are required to submit a PR. This list is here to help track what is remaining to implement before a technical review and discussion of moving into the main repository can occur.
71+
options:
72+
- label: Working Prototype
73+
- label: Feature Complete
74+
- label: Documentation
75+
- label: Samples
76+
- label: Unit Tests
77+
- label: Community Feedback / Usage Testimonies
78+
79+
- type: checkboxes
80+
id: tested-platforms
81+
attributes:
82+
label: Tested Platforms
83+
description: Which platforms has your current experiment code been tested with (by you or someone in the community)?
84+
options:
85+
- label: UWP
86+
- label: WinAppSDK / WinUI 3
87+
- label: Web Assembly (WASM)
88+
- label: Android
89+
- label: iOS
90+
- label: MacOS
91+
- label: Linux / GTK
92+
93+
- type: checkboxes
94+
id: technical-review
95+
attributes:
96+
label: Technical Review
97+
description: These items can sometimes be done ahead of time, but are usually started and completed after all implementation details are finished. You can _skip_ this section for now when opening a new experiment, though it's good to be familiar with these work items.
98+
options:
99+
- label: Accessibility Audit
100+
- label: API/Naming Review
101+
- label: Code Quality/Style
102+
- label: Dependency Review
103+
- label: Design/Style Review
104+
- label: Final Approval
105+
106+
- type: dropdown
107+
id: contribution
108+
attributes:
109+
label: Community Help?
110+
description: Would you like others to help you work on the deliverables for this experiment?
111+
options:
112+
- Yes
113+
- No

0 commit comments

Comments
 (0)