microsoft / microsoft/microsoft-ui-xaml

[WinUI OSS] Document WinUI API review process

Open
#11,321 0 comments 0 reactions 1 assignee View on GitHub

@beth-panx is already working on this.

Since Aug 25, 2026.

WinUI OSS
Dominant language
C++
Stars
8.4k
Forks
942
Avg merge
2d 7h
Merged PRs (30d)
105

Description

Summary

Document the public-facing API review process for WinUI changes so contributors and maintainers understand how API proposals move from idea to implementation.

Context

API changes often need more structure than ordinary code changes. Contributors should know when an API review is required, what information to include, where proposals should be discussed, and how review outcomes are reflected in issues or pull requests.

This task should document the public process at a high level without exposing private meeting notes, internal approval chains, or non-public design discussions.

Work to do

  • Identify the steps a contributor should follow when proposing a WinUI API change.
  • Document required proposal information, review expectations, and how decisions are communicated.
  • Link to public templates, examples, or guidance if available.
  • Clarify how API-review work connects to issues, pull requests, labels, and project tracking.
  • Avoid private meeting links, internal distribution lists, unpublished decisions, and internal escalation paths.

Definition of done

  • Contributors have clear public guidance for API review.
  • Maintainers have a consistent process to point contributors to.
  • API-review-related labels, templates, or issue fields are identified if needed.
  • Public documentation avoids private approval details and internal discussion links.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.