Skip to content

Commit 43cf51f

Browse files
committed
Update Markdown files
Fix-up MarkdownLint warnings
1 parent bc09868 commit 43cf51f

File tree

8 files changed

+146
-135
lines changed

8 files changed

+146
-135
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ assignees: ''
88

99
<!-- 🚨 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
1010
...
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 🚨 -->
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 ENGAGE WITH THE COMMUNITY TO GAIN FURTHER CLARITY REGARDING THE ISSUE 🚨 -->
1212

1313
## Describe the bug
1414

@@ -42,9 +42,9 @@ Steps to reproduce the behavior:
4242

4343
## Environment
4444

45-
<!-- Check one or more of the following options with "x" -->
45+
<!-- Check one or more of the following options with "x" and replace the {build_number} and {minor_version} with the actual values -->
4646

47-
NuGet Package(s):
47+
NuGet Package(s): <!-- Which NuGet Packages have you used -->
4848

4949
Package Version(s):
5050

@@ -55,7 +55,7 @@ Windows 10 Build Number:
5555
- [ ] October 2018 Update (17763)
5656
- [ ] May 2019 Update (18362)
5757
- [ ] May 2020 Update (19041)
58-
- [ ] Insider Build (build number: )
58+
- [ ] Insider Build ({build_number})
5959

6060
App min and target version:
6161

@@ -64,7 +64,7 @@ App min and target version:
6464
- [ ] October 2018 Update (17763)
6565
- [ ] May 2019 Update (18362)
6666
- [ ] May 2020 Update (19041)
67-
- [ ] Insider Build (xxxxx)
67+
- [ ] Insider Build ({build_number})
6868

6969
Device form factor:
7070

@@ -73,11 +73,11 @@ Device form factor:
7373
- [ ] Surface Hub
7474
- [ ] IoT
7575

76-
Visual Studio
76+
Visual Studio version:
7777

78-
- [ ] 2017 (version: )
79-
- [ ] 2019 (version: )
80-
- [ ] 2019 Preview (version: )
78+
- [ ] 2017 (15.{minor_version})
79+
- [ ] 2019 (16.{minor_version})
80+
- [ ] 2022 (17.{minor_version})
8181

8282
## Additional context
8383

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
<!-- 📝 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! 🎉 -->
66

7-
## Fixes #
7+
## Fixes
88

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. -->
9+
<!-- Add the relevant issue number after the word "Fixes" mentioned above (for ex: "## Fixes #1234") which will automatically close the issue once the PR is merged. -->
1010

1111
<!-- Add a brief overview here of the feature/bug & fix. -->
1212

@@ -35,10 +35,10 @@ What kind of change does this PR introduce?
3535

3636
## PR Checklist
3737

38-
Please check if your PR fulfills the following requirements:
38+
Please check if your PR fulfills the following requirements: <!-- and remove the ones that are not applicable to the current PR -->
3939

40-
- [ ] Tested code with current [supported SDKs](../readme.md#supported)
41-
- [ ] Pull Request has been submitted to the documentation repository [instructions](..\contributing.md#docs). Link: <!-- docs PR link -->
40+
- [ ] Tested code with current [supported SDKs](../#supported)
41+
- [ ] Pull Request has been submitted to the documentation repository [instructions](../blob/main/Contributing.md#docs). Link: <!-- docs PR link -->
4242
- [ ] Sample in sample app has been added / updated (for bug fixes / features)
4343
- [ ] Icon has been created (if new sample) following the [Thumbnail Style Guide and templates](https://github.com/CommunityToolkit/WindowsCommunityToolkit-design-assets)
4444
- [ ] 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...
@@ -50,3 +50,5 @@ Please check if your PR fulfills the following requirements:
5050
Please note that breaking changes are likely to be rejected within minor release cycles or held until major versions. -->
5151

5252
## Other information
53+
54+
<!-- Please add any other information that might be helpful to reviewers. -->

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ members of the project's leadership.
6868
## Attribution
6969

7070
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
71+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
7272

7373
[homepage]: https://www.contributor-covenant.org
7474

7575
For answers to common questions about this code of conduct, see
76-
https://www.contributor-covenant.org/faq
76+
<https://www.contributor-covenant.org/faq>

Contributing.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
1-
# Contributing to the Windows Community Toolkit :sparkles::sparkles:
1+
# Contributing to the Windows Community Toolkit
22

33
Thank you for exhibiting interest in contributing to the Windows Community Toolkit. The team is delighted to welcome you onboard to our exciting and growing project. Any contribution or value added go a long way to enhance the project!
44

55
In the next few steps, you will be able to see a glimpse of ways you can contribute to the Windows Community Toolkit.
66

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:
7+
🚨 **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** 🚨
88

9-
## <a name="question"></a> Questions :grey_question:
9+
## ❔ Questions <a name="question"></a>
1010

11-
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+
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`.
1212

1313
For missing documentation related question, please file an issue at [Microsoft Docs](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/issues/new).
1414

15-
## <a name="bug"></a> Fix a Bug :bug:
15+
## 🐛 Fix a Bug <a name="bug"></a>
1616

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.
17+
If you find any bug, you can help the community by [submitting an issue](https://github.com/CommunityToolkit/WindowsCommunityToolkit/issues/new?template=bug_report.md&labels=bug+:bug:&title=[Bug]). Once the issue is filed, feel free to start working on the PR and submit a PR.
1818

19-
## <a name="issue"></a>Good First Issue :ok_hand:
19+
## 👌 Good First Issue <a name="issue"></a>
2020

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.
21+
If this is your first time contributing to the Windows Community Toolkit (_WCT_) and do not have advanced level programming experience, we have got you covered 💥 WCT has a list of [good first issue](https://github.com/CommunityToolkit/WindowsCommunityToolkit/labels/good%20first%20issue) that can be a great entryway to find and fix any issues that best fit your expertise or technical background.
2222

23-
## <a name="help"></a>Help Wanted :raising_hand:
23+
## 🙋 Help Wanted <a name="help"></a>
2424

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.
25+
WCT also has a list of issues that are labeled as [help wanted](https://github.com/CommunityToolkit/WindowsCommunityToolkit/labels/help%20wanted). 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.
2626

27-
## <a name="feature"></a>Add New Feature :mailbox_with_mail:
27+
## 📬 Add New Feature <a name="feature"></a>
2828

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.
29+
* To contribute a new feature, fill out the [Feature Request Template](https://github.com/CommunityToolkit/WindowsCommunityToolkit/issues/new?template=feature_request.md&labels=feature+request+:mailbox_with_mail:&title=[Feature]) and provide detailed information to express the proposal.
3030
* Once the Feature Request is submitted, it will be open for discussion.
3131
* If it gets approved by the team, proceed to submit a PR of the proposed Feature.
3232
* If the PR contains an error-free code and the reviewer signs off, the PR will be merged.
3333

34-
## <a name="docs"></a> Add or Improve Documentation :page_with_curl:
34+
## 📝 Add or Improve Documentation <a name="docs"></a>
3535

3636
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.
3737

38-
## <a name="pr"></a>Create, Submit or Review Pull Request :rocket:
38+
## 🚀 Create, Submit or Review Pull Request <a name="pr"></a>
3939

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.
40+
Anyone 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.
4141

4242
Please visit [Windows Community Toolkit Wiki](https://aka.ms/wct/wiki) for detailed information and steps it requires to Submit or Review Pull Request.
4343

44-
# ThankYou :heart::heart:
44+
## 💙 Thank You
4545

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**
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.**

License.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Windows Community Toolkit
22

3-
Copyright (c) .NET Foundation and Contributors
3+
Copyright © .NET Foundation and Contributors
44

55
All rights reserved.
66

7-
# MIT License (MIT)
7+
## MIT License (MIT)
88

9-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
9+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
1010

1111
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
1212

13-
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
13+
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)