Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 4.06 KB

Create-and-Submit-PullRequest.md

File metadata and controls

38 lines (25 loc) · 4.06 KB
Raw

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

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.

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

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.

⚠️ 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 Documentation for the feature, see [[Improving Documentation]]
  • 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 and integration tests, see [[Testing]]

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 | Gallery) to your Visual Studio.