Skip to content

Review PR

Arlo Godfrey edited this page Mar 12, 2024 · 1 revision

Reviewing PR’s is essential before merging any changes regarding bug fixes, features, doc improvements etc. You can find the current list of PR’s here.

πŸŒ™ Each PR will also build Preview Packages, so if you're familiar with NuGet and already using the Toolkit, you can easily try new features with these builds. Otherwise, to build a PR yourself, follow the steps below.

Build Requirements

  • Visual Studio 2022 (UWP & Desktop Workloads for .NET)
  • .NET 6 SDK
  • Windows App SDK
  • Windows SDK 19041
  • Install GitHub CLI

Reviewing a PR

  • Open Command Prompt or Windows Terminal
  • Locate the place where you want the WCT clone to appear by using the cd path.
  • Go to Windows Community Toolkit repository.
  • Clone the Windows Community Toolkit as per instructions in Getting started.
  • Checkout PR by using gh pr checkout <PR #>.
  • Open a developer terminal, or a terminal with MSBuild in the path.
  • Generate the Community Toolkit solution as per instructions in Getting started.
  • You will see the PR checkout branch in the bottom right corner of the Visual Studio page. (By default it should have been on the main branch but since the PR checkout command has been performed; therefore, it’s on the branch that is ready to be tested).
  • Now select a platform from the dropdown and run the Windows Community Toolkit Gallery App as well.
  • Review and test the changes side by side.
  • Once approved signoff by leaving feedback and results.

πŸ’‘ List of GitHub CLI Commands that can be useful to manage Pull Request.

Overall, it is essential to make sure the PR is on the feature branch of the forked repository it does not contradict with any other changes. If it has multiple changes then make certain it is clearly stated in the PR Template with the detailed information and all the requirements of the PR checklist have been fulfilled.

It is also significant to watch if the PR contains any breaking changes or not. If the PR contains a breaking change, check for the detailed description of the impact and migration path for the existing application.

🚨 Breaking changes are likely to be rejected within minor release cycles or held until major versions.

About Windows Community Toolkit

Usage

Contribution

Development/Testing

Project Structure

Clone this wiki locally