Skip to content

Commit

Permalink
Merge pull request #28 from Kyaa-dost/Update-PullRequest
Browse files Browse the repository at this point in the history
Update PullRequest Contribution Page
  • Loading branch information
michael-hawker authored Jun 8, 2021
2 parents 6a647c3 + d2359b5 commit 0faff95
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 34 deletions.
11 changes: 0 additions & 11 deletions Create-Pull-Request.md

This file was deleted.

37 changes: 37 additions & 0 deletions Create-and-Submit-PullRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## How to Create a Pull Request?
The first step before starting to create a Pull Request (PR) is to ensure you've opened a [[Discussions]] or are [[Submitting an Issue]] describing the changes you wish to make. This allows the community and Toolkit team to be aware of your proposal and guide your new changes to success! If your change is only _minor and extremely focused_ (like fixing a typo), you may skip this step.

If this is your first time contributing to Windows Community Toolkit and never created a PR before, do not worry because you are not in this alone. By following [Github Help](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) guidelines you will be able to create your first Pull Request.

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://docs.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 a _feature branch_ of your forked repository. If you have the changes in the forked feature branch you can create a Pull Request in the main Windows Community Toolkit where your changes will be merged to the **main** branch.

:warning: **We will not merge the PR to the main repo if your changes are not in a feature branch of your forked repository** :warning:

Once the PR is created and submitted, we will be able to see the associated PR issue and will assist and provide feedback if necessary.

If you are not certain about the Pull Request submitted; our team along with the community members are here to review the work and highlight any changes the PR might require to fulfill any required obligation.

:warning: **It is important that a PR be singularly focussed on a single discrete change.** (i.e. Don't refactor a bunch of things, fix a bug, and add a new feature. These would be three distinct separate PRs.) Sometimes fixes may cross the scope of different controls or areas of the Toolkit, it is OK to submit a single PR for these types of changes if they are narrow in focus to resolving a problem across areas (e.g. fixing the same class of accessibility issue across multiple controls.). Otherwise, don't submit a PR that fixes two completely different types of issues.

## How to Submit a Pull Request?

For every contribution, you must:
* Test your code with the supported SDKs
* Follow the quality guidance, general rules, and naming convention
* Target main branch (or an appropriate release branch if appropriate for a bug fix)
* Follow the Windows Community Toolkit PR Template
* If adding a new feature
* Before starting coding, you should open an issue and start discussing with the community to see if your idea/feature is interesting enough.
* Add or update a sample for the Sample app
* If creating a new sample, create a new icon by following the Thumbnail Style Guide and templates
* Add or update unit tests (if applicable)

A PR must be validated by at least two core members before being merged, though having other community members validate your PR is always welcome and encouraged, see [[Review PR]].

Please make certain that the PR successfully passes all three status check requirements including Toolkit-CI, WIP, license/cla. If it fails and you are aware of the reasoning please fix the error. If you are unaware of the reasoning please escalate by commenting in the PR, and someone from the team will investigate the build error.

If the PR passes all the requirements above and reviewers have signed off, the PR can be merged.

Once merged, you can get a pre-release package of the toolkit by adding this ([Azure DevOps feed](https://pkgs.dev.azure.com/dotnet/WindowsCommunityToolkit/_packaging/WindowsCommunityToolkit-MainLatest/nuget/v3/index.json) | [Gallery](https://dev.azure.com/dotnet/WindowsCommunityToolkit/_packaging?_a=feed&feed=WindowsCommunityToolkit-MainLatest)) to your Visual Studio.
4 changes: 2 additions & 2 deletions Questions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
It is critical to understand the kind of questions you might have. Since Windows Community Toolkit receives volumes of issues regularly; we want to make certain that every question receives an answer as soon as possible. Therefore, please do not open issues for general support questions and keep our GitHub issues for [[Bug Fixes]] and [[Feature Requests]].
It is critical to understand the kind of questions you might have. Since Windows Community Toolkit receives volumes of issues regularly; we want to make certain that every question receives an answer as soon as possible. Therefore, please do not open issues for general support questions and keep our GitHub issues for [[Bug Fixes]] and [[Feature Requests]]. You can use [[Discussions]] instead to start general conversations with our team and community.

There is a much better chance of getting your question answered on [Stack Overflow](https://stackoverflow.com/questions/tagged/windows-community-toolkit) where questions should be tagged with the tag `windows-community-toolkit`. You can also chat with community members about the project in our [UWP Community Discord](https://discord.gg/zBA5aCn) channel.
Though, there may be a much better chance of getting your question answered on [Stack Overflow](https://stackoverflow.com/questions/tagged/windows-community-toolkit) where questions should be tagged with the tag `windows-community-toolkit`. You can also chat with community members about the project in our [UWP Community Discord](https://discord.gg/zBA5aCn) channel.

If there is any question related to missing documentation, please file an issue instead at [Microsoft Docs](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/issues/new) 📝
17 changes: 0 additions & 17 deletions Submit-Pull-Request.md

This file was deleted.

2 changes: 1 addition & 1 deletion Submitting-an-Issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@

* **Now What?**

\> [[Questions]] | [[Bug Fixes]] | [[Feature Requests]] | [[Discussions]]
\> [[Discussions]] | [[Questions]] | [[Bug Fixes]] | [[Feature Requests]]
5 changes: 2 additions & 3 deletions _sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,16 @@

### Contribution

* [[Discussions]] 👥
* [[Submitting an Issue]] ✔️
* [[Good First Issue]] 👌
* [[Help Wanted]] 🙋
* [[Bug Fixes]] 🐛
* [[Feature Requests]] 📫
* [[Create Pull Request]] 🔥
* [[Submit Pull Request]] 🚀
* [[Create and Submit PullRequest]] 🚀
* [[Add Documentation]] 📝
* [[Improve Documentation]] ♻️
* [[Review PR]] 📖
* [[Discussions]] 👥
* [[Building XAML Controls]] 🎛
* [[Coding Style and Conventions]]
* [[Accessibility Guideline]]
Expand Down

0 comments on commit 0faff95

Please sign in to comment.