You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug_report.md
+17-8Lines changed: 17 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -4,23 +4,26 @@ about: Create a report to help us fix something that isn't working as expected
4
4
title: ''
5
5
labels: "bug :bug:"
6
6
assignees: ''
7
-
8
7
---
9
8
10
9
<!-- 🚨 PLEASE DO NOT SKIP ANY INSTRUCTIONS AND INFORMATION MENTIONED BELOW AS THEY ARE ALL REQUIRED AND ESSENTIAL TO INVESTIGATE THE ISSUE. ISSUES WITH MISSING INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION
11
10
...
12
11
IF NOT CERTAIN ABOUT THE ISSUE AND REQUIRE MORE CLARITY THEN PLEASE POST ON "QUESTIONS & HELP" CATEGORY OF THE DISCUSSIONS PLATFORM [https://github.com/CommunityToolkit/WindowsCommunityToolkit/discussions/categories/questions-help] WHERE YOU CAN DISCUSS AND ENAGAGE WITH THE COMMUNITY TO GAIN FURTHER CLAIRITY REGARDING THE ISSUE 🚨 -->
13
12
14
13
## Describe the bug
14
+
15
15
A clear and concise description of what the bug is.
16
16
17
17
-[ ] Is this bug a regression in the toolkit? If so, what toolkit version did you last see it work:
18
18
19
19
## Steps to Reproduce
20
20
21
-
-[ ] Can this be reproduced in the Sample App? (Either in a sample as-is or with new XAML pasted in the editor.) If so, please provide custom XAML or steps to reproduce. If not, let us know why it can't be reproduced (e.g. more complex setup, environment, dependencies, etc...) <!-- Being able to reproduce the problem in the sample app, really stream-lines the whole process in being able to discover, resolve, and validate bug fixes. -->
21
+
-[ ] Can this be reproduced in the Sample App? (Either in a sample as-is or with new XAML pasted in the editor.) If so, please provide custom XAML or steps to reproduce. If not, let us know why it can't be reproduced (e.g. more complex setup, environment, dependencies, etc...)
22
+
23
+
<!-- Being able to reproduce the problem in the sample app, really stream-lines the whole process in being able to discover, resolve, and validate bug fixes. -->
22
24
23
25
Steps to reproduce the behavior:
26
+
24
27
1. Given the following environment (Sample App w/ XAML, Project with Isolated setup, etc...)
25
28
2. Go to '...'
26
29
3. Click on '....'
@@ -30,19 +33,23 @@ Steps to reproduce the behavior:
30
33
<!-- Provide as many code-snippets or XAML snippets where appropriate. -->
31
34
32
35
## Expected behavior
33
-
A clear and concise description of what you expected to happen.
36
+
37
+
<!-- A clear and concise description of what you expected to happen. -->
34
38
35
39
## Screenshots
36
-
If applicable, add screenshots to help explain your problem.
40
+
41
+
<!-- If applicable, add screenshots to help explain your problem. -->
37
42
38
43
## Environment
44
+
39
45
<!-- Check one or more of the following options with "x" -->
40
-
```
46
+
41
47
NuGet Package(s):
42
48
43
49
Package Version(s):
44
50
45
51
Windows 10 Build Number:
52
+
46
53
-[ ] Fall Creators Update (16299)
47
54
-[ ] April 2018 Update (17134)
48
55
-[ ] October 2018 Update (17763)
@@ -51,6 +58,7 @@ Windows 10 Build Number:
51
58
-[ ] Insider Build (build number: )
52
59
53
60
App min and target version:
61
+
54
62
-[ ] Fall Creators Update (16299)
55
63
-[ ] April 2018 Update (17134)
56
64
-[ ] October 2018 Update (17763)
@@ -59,17 +67,18 @@ App min and target version:
59
67
-[ ] Insider Build (xxxxx)
60
68
61
69
Device form factor:
70
+
62
71
-[ ] Desktop
63
72
-[ ] Xbox
64
73
-[ ] Surface Hub
65
74
-[ ] IoT
66
75
67
76
Visual Studio
77
+
68
78
-[ ] 2017 (version: )
69
79
-[ ] 2019 (version: )
70
80
-[ ] 2019 Preview (version: )
71
81
72
-
```
73
-
74
82
## Additional context
75
-
Add any other context about the problem here.
83
+
84
+
<!-- Add any other context about the problem here. -->
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/feature_request.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -4,27 +4,27 @@ about: I have a new idea or improvement for the toolkit
4
4
title: "[Feature]"
5
5
labels: "feature request :mailbox_with_mail:"
6
6
assignees: ''
7
-
8
7
---
9
8
10
9
<!-- 🚨 PLEASE PROVIDE DETAILED INFORMATION AND DO NOT SKIP ANY INSTRUCTIONS AND INFORMATION MENTIONED BELOW AS THEY ARE ALL REQUIRED AND ESSENTIAL TO HELP US UNDERSTAND THE FEATURE.
11
10
...
12
-
IF NOT CERTAIN ABOUT THE FEATURE AND REQUIRE MORE CLARITY THEN PLEASE POST ON "IDEAS" CATEGORY OF THE DISCUSSIONS PLATFORM [https://github.com/CommunityToolkit/WindowsCommunityToolkit/discussions/categories/ideas] WHERE YOU CAN DISCUSS AND ENAGAGE WITH THE COMMUNITY TO GAIN FURTHER CLAIRITY REGARDING THE FEATURE 🚨 -->
11
+
IF NOT CERTAIN ABOUT THE FEATURE AND REQUIRE MORE CLARITY THEN PLEASE POST ON "IDEAS" CATEGORY OF THE DISCUSSIONS PLATFORM [https://github.com/CommunityToolkit/WindowsCommunityToolkit/discussions/categories/ideas] WHERE YOU CAN DISCUSS AND ENGAGE WITH THE COMMUNITY TO GAIN FURTHER CLARITY REGARDING THE FEATURE 🚨 -->
13
12
14
13
## Describe the problem this feature would solve
14
+
15
15
<!-- Please describe or link to any existing issues or discussions.
16
16
A clear and concise description of what the problem is, starting with the user story.
17
17
Provide examples of the restrictions in the current environment that hinders the work your users or you want to perform. What are the ways this new feature will help transform and deliver those results?
18
18
For example, I am currently using the InfiniteCanvas control which lacks the TabbedCommandBar control feature. I am looking to improve user experience therefore i would like to use that in my project to provide ease of accessibility and a user-friendly interface. This new feature will provide quick access to the toolbar, enhance space utilization, etc [...] -->
19
19
20
-
21
20
## Describe the solution
22
-
<!-- A clear and concise description of what you want to happen. Define how do you think it will help the community and adds value to the toolkit? -->
23
21
22
+
<!-- A clear and concise description of what you want to happen. Define how do you think it will help the community and adds value to the toolkit? -->
24
23
25
24
## Describe alternatives you've considered
26
-
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
27
25
26
+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
28
27
29
28
## Additional context & Screenshots
29
+
30
30
<!-- Add any other context or screenshots about the feature request here.-->
<!-- 🚨 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 🚨 -->
2
2
3
-
<!-- 👉 It is imperative to resolve ONE ISSUE PER PR and avoid making multiple changes unless the changes interrelate with each other -->
3
+
<!-- 👉 It is imperative to resolve ONE ISSUE PER PR and avoid making multiple changes unless the changes interrelate with each other -->
4
4
5
5
<!-- 📝 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! 🎉 -->
6
6
7
-
8
7
## Fixes #
8
+
9
9
<!-- Add the relevant issue number after the "#" mentioned above (for ex: "## Fixes #1234") which will automatically close the issue once the PR is merged. -->
10
10
11
11
<!-- Add a brief overview here of the feature/bug & fix. -->
12
12
13
13
## PR Type
14
+
14
15
What kind of change does this PR introduce?
16
+
15
17
<!-- Please uncomment one or more options below that apply to this PR. -->
16
18
17
19
<!-- - Bugfix -->
@@ -23,14 +25,13 @@ What kind of change does this PR introduce?
23
25
<!-- - Sample app changes -->
24
26
<!-- - Other... Please describe: -->
25
27
26
-
27
28
## What is the current behavior?
28
-
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
29
29
30
+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
30
31
31
32
## What is the new behavior?
32
-
<!-- Describe how was this issue resolved or changed? -->
33
33
34
+
<!-- Describe how was this issue resolved or changed? -->
34
35
35
36
## PR Checklist
36
37
@@ -39,14 +40,13 @@ Please check if your PR fulfills the following requirements:
39
40
-[ ] Tested code with current [supported SDKs](../readme.md#supported)
40
41
-[ ] Pull Request has been submitted to the documentation repository [instructions](..\contributing.md#docs). Link: <!-- docs PR link -->
41
42
-[ ] Sample in sample app has been added / updated (for bug fixes / features)
42
-
-[ ] Icon has been created (if new sample) following the [Thumbnail Style Guide and templates](https://github.com/CommunityToolkit/WindowsCommunityToolkit-design-assets)
43
+
-[ ] Icon has been created (if new sample) following the [Thumbnail Style Guide and templates](https://github.com/CommunityToolkit/WindowsCommunityToolkit-design-assets)
43
44
-[ ] New major technical changes in the toolkit have or will be added to the [Wiki](https://github.com/CommunityToolkit/WindowsCommunityToolkit/wiki) e.g. build changes, source generators, testing infrastructure, sample creation changes, etc...
44
45
-[ ] Tests for the changes have been added (for bug fixes / features) (if applicable)
45
-
-[ ] Header has been added to all new source files (run *build/UpdateHeaders.bat*)
46
+
-[ ] Header has been added to all new source files (run _build/UpdateHeaders.bat_)
46
47
-[ ] Contains **NO** breaking changes
47
48
48
49
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below.
49
-
Please note that breaking changes are likely to be rejected within minor release cycles or held until major versions. -->
50
-
50
+
Please note that breaking changes are likely to be rejected within minor release cycles or held until major versions. -->
Copy file name to clipboardExpand all lines: Contributing.md
+11-4Lines changed: 11 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -7,33 +7,40 @@ In the next few steps, you will be able to see a glimpse of ways you can contrib
7
7
:rotating_light:**It is highly recommended to visit [Windows Community Toolkit Wiki](https://aka.ms/wct/wiki) where you can find complete and detail-oriented content of this page**:rotating_light:
Due to the high volume of incoming issues please keep our GitHub issues for bug reports and feature requests. For general questions, there is a higher chance of getting your question answered on [StackOverflow](https://stackoverflow.com/questions/tagged/windows-community-toolkit) where questions should be tagged with the tag windows-community-toolkit.
11
12
12
13
For missing documentation related question, please file an issue at [Microsoft Docs](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/issues/new).
13
14
14
15
## <aname="bug"></a> Fix a Bug :bug:
16
+
15
17
If you find any bug, you can help the community by [submitting an issue](https://github.com/CommunityToolkit/WindowsCommunityToolkit/issues/new?assignees=&labels=bug+%3Abug%3A&template=bug_report.md&title=). Once the issue is filed, feel free to start working on the PR and submit a PR.
16
18
17
19
## <aname="issue"></a>Good First Issue :ok_hand:
20
+
18
21
If this is your first time contributing to the Windows Community Toolkit and do not have advanced level programming experience, we have got you covered :boom: WCT has a list of [good first issue](https://github.com/CommunityToolkit/WindowsCommunityToolkit/labels/good%20first%20issue%20%3Aok_hand%3A) that can be a great entryway to find and fix any issues that best fit your expertise or technical background.
19
22
20
23
## <aname="help"></a>Help Wanted :raising_hand:
24
+
21
25
WCT has a list of issues that are labeled as [help wanted](https://github.com/CommunityToolkit/WindowsCommunityToolkit/labels/help%20wanted%20%3Araising_hand%3A). The level of complexity in the list can vary but if you have an advanced level of programming experience, feel free to jump in to solve these issues.
22
26
23
27
## <aname="feature"></a>Add New Feature :mailbox_with_mail:
24
-
* To contribute a new feature, fill out the [Feature Request Template](https://github.com/CommunityToolkit/WindowsCommunityToolkit/issues/new?assignees=&labels=feature+request+%3Amailbox_with_mail%3A&template=feature_request.md&title=%5BFeature%5D) and provide detailed information to express the proposal.
25
-
* Once the Feature Request is submitted, it will be open for discussion.
26
-
* If it gets approved by the team, proceed to submit a PR of the proposed Feature.
27
-
* If the PR contains an error-free code and the reviewer signs off, the PR will be merged.
28
+
29
+
* To contribute a new feature, fill out the [Feature Request Template](https://github.com/CommunityToolkit/WindowsCommunityToolkit/issues/new?assignees=&labels=feature+request+%3Amailbox_with_mail%3A&template=feature_request.md&title=%5BFeature%5D) and provide detailed information to express the proposal.
30
+
* Once the Feature Request is submitted, it will be open for discussion.
31
+
* If it gets approved by the team, proceed to submit a PR of the proposed Feature.
32
+
* If the PR contains an error-free code and the reviewer signs off, the PR will be merged.
28
33
29
34
## <aname="docs"></a> Add or Improve Documentation :page_with_curl:
30
35
31
36
Due to the involvement of multiple steps to add or improve documents; it is required to visit [Windows Community Toolkit Wiki](https://aka.ms/wct/wiki) and follow contribution guidelines.
32
37
33
38
## <aname="pr"></a>Create, Submit or Review Pull Request :rocket:
39
+
34
40
Anyone with write access can create a Pull Request by forking the Windows Community Toolkit Repository. Here is how you can [Create a Pull Request from fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Once you fork the Windows Community Toolkit repo, it is essential to create all changes in the feature branch of your forked repository. If you have the changes in the forked feature branch, you can then create a Pull Request in the main Windows Community Toolkit.
35
41
36
42
Please visit [Windows Community Toolkit Wiki](https://aka.ms/wct/wiki) for detailed information and steps it requires to Submit or Review Pull Request.
37
43
38
44
# ThankYou :heart::heart:
45
+
39
46
**Thank you so much for contributing to this amazing project. We hope you will continue to add value and find yourself as a highly reliable source to the Windows Community Toolkit**
Copy file name to clipboardExpand all lines: Microsoft.Toolkit.Uwp.SampleApp/ReadMe.md
+13-5Lines changed: 13 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,4 @@
1
+
1
2
For the latest info, [visit the wiki article here](https://github.com/CommunityToolkit/WindowsCommunityToolkit/wiki/Sample-Development).
2
3
3
4
# How to add new samples
@@ -8,6 +9,7 @@ This document describes how to add a new sample page for a new control you want
8
9
9
10
10
11
## 1. Add Sample page and .bind template
12
+
11
13
First you need to create a Xaml page in the folder /SamplePages/YourControl. This will be the logical page used to by the app to navigate to the sample and contains code.
12
14
13
15
If providing 'live' XAML, a .bind file is loaded and dynamically fed to the XamlReader.Load method to convert into actual controls. This changes a few things about how samples need to be written (detailed below), but allows developers to actually change the sample and see the results live.
@@ -16,6 +18,7 @@ This not only gives us a killer sample app, but it also means that all our sampl
16
18
17
19
18
20
## 2. Binding text
21
+
19
22
The .bind files are templates which use @[Property Name:Type:DefaultValue:Options] syntax to allow for customized options to be presented to the user in the sample app. The user can play with the values in the property page and see results change instantly. This is accomplished by using {Binding} syntax when on the property page, but switches to the raw value when the developer goes to the XAML page.
20
23
21
24
This makes it easy for a developer to test out values for a control and then copy the XAML needed for that exact result into their app.
## 3. Have a *'Shallow Copy'* of your example in the sample page
92
+
89
93
Even though the sample page content is ignored and the dynamic template injected, for the XamlReader to access some classes, a reference to the item is sometimes needed in the hosting app for it to be accessible. (I assume it's an optimization thing.)
90
94
91
95
Therefore, for any new control/extension, you should still have a simplified snippet of it contained in the sample page compiled/loaded by the app. You should remove names, events, and properties (unless extensions) from these so the namespace isn't accidentally polluted. If you re-use the same control, you don't have to include it twice.
92
96
93
97
94
98
## 4. For Events/Resource Templates: Have your sample page implement the **IXamlRendererListener** interface
99
+
95
100
This gets called whenever the template gets parsed (due to loading or user modification). Here you can use the [LogicalTree](https://github.com/CommunityToolkit/WindowsCommunityToolkit/blob/main/Microsoft.Toolkit.Uwp.UI/Extensions/Tree/LogicalTree.cs) extensions to grab named controls in the template and register their events. **Check for null first** as the developer may have removed the name from the element.
96
101
97
102
```csharp
@@ -106,6 +111,7 @@ You'll have to register all events and grab **control.Resources** for templates
106
111
107
112
108
113
## 5. For Interactive Buttons: Use **SampleController.Current.RegisterNewCommand**
114
+
109
115
Buttons can be added through this command and are accessible in the main panel so they can be clicked when changing properties or editing XAML. It's important instead of using buttons in your sample (as events can't be directly used, see above) to register these commands.
110
116
111
117
```csharp
@@ -129,10 +135,12 @@ if (resources?.ContainsKey("ThingStyle") == true)
129
135
```
130
136
131
137
## 6. *Optional:* If you need *extra stuff* around the sample
0 commit comments