Skip to content

Contributing guide: Add information about WinUI's API spec discussions #3312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 24, 2020
Merged

Contributing guide: Add information about WinUI's API spec discussions #3312

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c69cc71
Contributing guide: Add information about WinUI's spec discussions
Felix-Dev Sep 22, 2020
2c42e30
Improve wording.
Felix-Dev Sep 22, 2020
b17c40f
Make github link language agnostic
Felix-Dev Sep 22, 2020
70dbe9f
CR feedback
Felix-Dev Sep 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to the Windows UI Library

We welcome your input and contributions to all aspects of WinUI, including bug reports, doc updates, feature proposals, and code contributions.
We welcome your input and contributions to all aspects of WinUI, including bug reports, doc updates, feature proposals, code contributions and API spec discussions.

This document contains general guidance. More specific guidance is included in the documents linked below.

Expand Down Expand Up @@ -73,3 +73,9 @@ You can find usage examples of the controls available in WinUI in the Xaml Contr

which can also be installed from the Windows Store:
https://www.microsoft.com/p/xaml-controls-gallery/9msvh128x2zt

## API spec discussions

Before new features will be implemented the WinUI team will do a thorough API spec discussion (API review). This can range from a single new API to an entire new control featuring dozens of new APIs. Joining such a spec discussion is a great opportunity for developers to help ensuring that new WinUI APIs will look and feel natural and are a joy to work with. In addition, spec discussions are the follow-up to feature proposals and will go into much finer details than the initial proposal. As such, taking part in these discussions gives developers the chance to be involved in the complete development process of new WinUI features - from their initial high-level inception right down to specific implementation/behavior details.

These discussions will be take place in their own [repository](https://github.com/microsoft/microsoft-ui-xaml-specs). While API specs for feature proposals will typically be linked to in the specific proposal on the WinUI repository, not all active API specs will immediately be mentioned there. Thus, if you don't want to miss out on them, we recommend that you [watch the repository](https://docs.github.com/en/enterprise/2.15/user/articles/watching-and-unwatching-repositories).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An API spec not (initially) mentioned by the team on the WinUI repo for example is the Application and Windowing Spec for WinUI 3. The spec could only be discovered by a community member if they were watching the specs repo or another member of the community mentioned it to them.