From 4c50e610e537aca92afc950c4be1ffb60c2f99d5 Mon Sep 17 00:00:00 2001 From: Duncan MacMichael Date: Mon, 25 Sep 2023 12:49:03 -0700 Subject: [PATCH] Adding new document for contribution handling (#8761) * Adding document for handling contributions, and links to it --- .../winui-toolkit-bug-report.md | 26 --------- CONTRIBUTING.md | 10 +--- README.md | 6 +- docs/contribution_handling.md | 55 +++++++++++++++++++ docs/roadmap.md | 45 +-------------- docs/triage.md | 5 +- 6 files changed, 68 insertions(+), 79 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/winui-toolkit-bug-report.md create mode 100644 docs/contribution_handling.md diff --git a/.github/ISSUE_TEMPLATE/winui-toolkit-bug-report.md b/.github/ISSUE_TEMPLATE/winui-toolkit-bug-report.md deleted file mode 100644 index d539ca3909..0000000000 --- a/.github/ISSUE_TEMPLATE/winui-toolkit-bug-report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: WinUI Design Toolkit Bug report -about: File a WinUI Design Toolkit bug report -title: 'WinUI Design Toolkit Bug: [descriptive bug title here]' -labels: area-DesignToolkit, team-Design -assignees: '' - ---- - -## WinUI Toolkit Bug Report - ---- - - - -**Name of component or part of Toolkit:** - - -**Describe the bug:** - - -**Version Info:** - - -**Additional context:** - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61726d6707..4ac695fb46 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,18 +1,14 @@ # Contributing to the Windows UI Library -We welcome your input and contributions to all aspects of WinUI, including bug reports, doc updates, feature proposals, code contributions and API spec discussions. +We welcome your input and contributions to all aspects of WinUI, including bug reports, doc updates, feature proposals, and API spec discussions. This document contains general guidance. More specific guidance is included in the documents linked below. Note that all community interactions must abide by the [Code of Conduct](CODE_OF_CONDUCT.md). -## Issues +## How we work with contributions -We use GitHub issues to track bugs and features. - -For reporting security issues please see the [Security Policy](docs/SECURITY.md). - -For all other bugs and general issues please [file a new issue](https://github.com/Microsoft/microsoft-ui-xaml/issues/new/choose) using the Bug Report template. +Contributions from the community in the form of feature requests and bugs are handled according to our [contribution handling](docs/contribution_handling.md) guidelines. ## New contributors diff --git a/README.md b/README.md index dc55dece85..b562d6d668 100644 --- a/README.md +++ b/README.md @@ -59,9 +59,11 @@ To view the WinUI controls in an interactive format, check out the Xaml Controls [WinUI](https://microsoft.github.io/microsoft-ui-xaml/) also has its own website where you can learn more about it. ## Contributing to WinUI -The WinUI team welcomes feedback and contributions! +The WinUI team welcomes your feedback! -For information on how to contribute please see [Contributing to the Windows UI Library](CONTRIBUTING.md). +To understand how we handle incoming feature requests and bugs, please see our [contribution handling](docs/contribution_handling.md) guidelines. + +For information on how to contribute, please see [Contributing to the Windows UI Library](CONTRIBUTING.md). For guidelines on making an impact on WinUI through non-code contributions, please see [Contributing ideas, feedback, and requests](CONTRIBUTING_feedback_and_requests.md). diff --git a/docs/contribution_handling.md b/docs/contribution_handling.md new file mode 100644 index 0000000000..f069ff486e --- /dev/null +++ b/docs/contribution_handling.md @@ -0,0 +1,55 @@ +# WinUI Repo Contribution Handling + +The WinUI repo is intended as a place for the WinUI team to gather community feedback, discuss issues with the community, and provide insight into bug fixes that the team is working on before updates are released. Here, we'll outline how we handle feature requests and bugs that the community opens. + +## Issues + +Feature requests and bugs are tracked as GitHub issues. + +For reporting security issues please see the [Security Policy](SECURITY.md). + +For all other bugs and general issues please [file a new issue](https://github.com/Microsoft/microsoft-ui-xaml/issues/new/choose) using the Bug Report template. + +Please file questions and discussions as discussions, not issues. + +## Feature Proposals + +Feature proposals for WinUI 3 are categorized based on the likely timeframe in which the feature team can consider them. + +1. Short-term, less than a year +2. Long-term, not likely in the next year + +All feature proposals are automatically categorized as long-term and unlikely to be considered, although the WinUI team might change the priority based on customer and business needs. If the WinUI team does close a feature proposal, we will indicate the reason why and how it fits into our plans. Closing a proposal does not mean that the team will never consider it. We encourage the community to add comments or interact with a proposal at any time, even a closed one, to signal its importance to the team. + +### Feature Planning + +Our long term vision for WinUI is to be the best UX/UI native framework for Windows PCs that provides premium visuals, motion, accessibility, usability, and support for all input modalities. + +The current details of what we plan long-term are shaped by evolving priorities that are subject to frequent change and are often confidential based on business and customer needs. However, we are happy to share our immediate plans for what's coming next in the next major release once the feature list is ready. Additionally, preview and experimental releases provide opportunities for the community to see what's new and what's changing on a more frequent basis. + +For more info about our longer-term planning, see the [Windows App SDK feature roadmap](https://github.com/microsoft/WindowsAppSDK/blob/main/docs/roadmap.md). This page will be updated generally right after a major release, when the features for the next release are solidified enough to share. + +## Bugs + +### WinUI 2 + +The WinUI team is currently spending its time on WinUI 3. To help with this focus, new bugs filed against WinUI 2 are closed in this repo unless they're a security issue or are business critical. + +### WinUI 3 + +WinUI 3 bugs are triaged and prioritized based on how much the bug impacts one or more of the following criteria. If a bug has lower impact, it is less likely to be considered for fixing. + +- Reliability +- Data corruption or loss +- Functionality (such as a major regression) +- Security +- Compatibility with applications +- User experience/usability +- Performance +- Compliance (such as legal compliance) +- Accessibility +- Build and deployment + +Bugs filed in relation to preview and experimental releases are triaged with the same criteria as stable releases and are intended to assist in identifying and fixing those bugs before they make their way to a stable release. + +Bugs filed on GitHub will be automatically mirrored to our internal bug tracking system and updates to them are automatically mirrored back to GitHub with appropriate tags. This way, the bugs we're working on and their progress are transparent. The only information we will reflect from our system externally is the state and release of the bug, not all the fine details; if a bug is resolved or closed, that's reflected on GitHub, and as bugs are worked on, the release for that fix will be reflected with a milestone on GitHub. \ No newline at end of file diff --git a/docs/roadmap.md b/docs/roadmap.md index 13fe694f95..93be34ca98 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -52,48 +52,9 @@ We also ship experimental features as we develop them. You can read more about t [Experimental release channel for the Windows App SDK](https://docs.microsoft.com/windows/apps/windows-app-sdk/experimental-channel). -### Features by release -Legend: - -🟢 - Available as supported feature - -🔷 - Available as experimental feature - -Blank - Not available - -**WinUI 3 - Windows App SDK 1.3** is our latest release. - -| Customer Capability | Project Reunion 0.5
(March 2021) | Windows App SDK 0.8
(June 2021) | Windows App SDK 1.0
(November 2021) | Windows App SDK 1.1
(June 2022) | Windows App SDK 1.2
(November 2022) | Windows App SDK 1.3
(April 2023) -| ------------------- | -------------------------------- | ------------------------------- | ----------------------------- | -----| ----- | ----- | -| Supported in any app using the Windows App SDK | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| Contains new Windows 11 controls/styles from WinUI 2.6 | | | 🟢 | 🟢 | 🟢 | 🟢 -| Supports MSIX Deployment | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| Supports Unpackaged (non-MSIX) Deployment | | | 🟢 | 🟢 | 🟢 | 🟢 -| Works downlevel to Windows 10 version 1809 and above | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| Supports the latest .NET | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| ARM64 support | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| ` ` | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| Intellisense, Hot Reload, Live Visual Tree | 🔷 | 🔷 | 🟢[^1] | 🟢[^1] | 🟢[^1] | 🟢[^1] -| Chromium-based WebView2 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| Title bar customization | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| Fluent Shadows | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| Input validation for data fields | 🔷 | 🔷 | 🔷 | 🔷 | 🔷 | 🔷 -| Supports multiple top-level windows on the same thread | 🔷 | 🔷 | 🟢[^2] | 🟢 | 🟢 | 🟢 -| Supports multiple top-level windows on separate threads | 🔷 | 🔷 | 🔷 | 🔷 | 🔷 | 🔷 -| Drag and drop | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| RenderTargetBitmap | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| Mouse cursor customization | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| Animated Gif support | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| VirtualSurfaceImageSource (VSIS) support | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| In-app acrylic | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 -| XAML Islands | | 🔷 | 🔷 | 🔷 | 🔷 | 🔷 -| Mica | | | | 🟢 | 🟢 | 🟢 -| Widgets | | | | | 🟢 | 🟢 -| Media playback controls | | | | | 🟢 | 🟢 -| InfoBadge and other updates from WinUI 2.8 | | | | | 🟢 | 🟢 - -[^1]: Supported on Visual Studio 2022 Preview 5 and above for packaged apps only -[^2]: Supported in 1.0.1 and above +### Roadmap + +For more info about upcoming features in the next release of WinUI 3, see the [Windows App SDK feature roadmap](https://github.com/microsoft/WindowsAppSDK/blob/main/docs/roadmap.md). ## WinUI 2 Controls Library diff --git a/docs/triage.md b/docs/triage.md index 59d34ffd74..75d952138d 100644 --- a/docs/triage.md +++ b/docs/triage.md @@ -5,6 +5,8 @@ The WinUI team manages issues and PRs in the repo using a process we call "triage". It helps us keep issues organized and focuses the attention of the different groups that work in our project. +For more info about our strategy for triaging bugs, see how we [handle contributions](contribution_handling.md). + ### Triage labels 1. New and re-opened issues are marked with `needs-triage`. @@ -34,8 +36,7 @@ The temporary `needs-assignee-attention` label is intended for issues which need ### Backlog -[Assigned issues](https://github.com/microsoft/microsoft-ui-xaml/issues/assigned/*) are being investigated or worked on. This doesn't mean they *will* be fixed soon, just that they are on the -short list for that person to investigate, and possibly fix. They may get unassigned. +[Assigned issues](https://github.com/microsoft/microsoft-ui-xaml/issues/assigned/*) are being investigated or worked on. This doesn't mean they *will* be fixed soon, just that they are on the short list for that person to investigate, and possibly fix. They may get unassigned. [Unassigned issues](https://github.com/microsoft/microsoft-ui-xaml/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+no%3Aassignee) are the backlog.