Microsoft UI XAML 项目代码贡献流程详解

Microsoft UI XAML 项目代码贡献流程详解

microsoft-ui-xaml Windows UI Library: the latest Windows 10 native controls and Fluent styles for your applications 项目地址: https://gitcode.com/gh_mirrors/mi/microsoft-ui-xaml

前言

Microsoft UI XAML（简称WinUI）是微软推出的现代化UI框架，为Windows应用提供Fluent Design风格的控件和功能。作为开源项目，它欢迎开发者参与贡献。本文将详细介绍如何规范地为该项目提交代码变更。

准备工作

在开始贡献代码前，建议先熟悉项目的基本架构和代码风格。可以通过以下方式准备：

1. 阅读项目文档和代码规范
2. 构建并运行示例项目
3. 了解现有的issue和PR讨论

工作流程详解

1. 创建或认领issue

对于非微小改动，建议先创建issue或认领现有issue：

• 对于公共API或UI的变更，必须遵循新功能讨论流程
• 明确表达你打算实现该功能的意愿
• 如果是修复bug，建议先添加重现问题的测试用例

2. 创建开发分支

从主分支(main)创建特性分支：

git checkout -b feature/your-feature-name

分支命名应清晰表达意图，例如：

• fix/button-click-issue
• feat/add-new-control

3. 代码实现与提交

实现变更时需注意：

• 严格遵循项目现有代码风格
• 每个提交应聚焦单一功能或修复
• 提交信息格式规范（后文详述）
• 为新功能添加相应测试

4. 本地验证

提交PR前必须完成：

• 完整项目构建
• 所有测试通过（包括新增测试）
• UI变更的视觉验证

5. 创建Pull Request

创建PR时注意：

• 目标分支应为上游main分支
• 初始阶段可使用"[WIP]"前缀标记未完成工作
• 详细描述变更内容和相关issue
• 大型PR建议先讨论设计方案

代码规范与最佳实践

应该做的

• 优先采用文件现有风格，即使与通用规范不一致
• 新功能必须包含测试用例
• bug修复应先添加重现问题的测试
• 保持讨论专注，无关话题应开新issue

应该避免的

• 仅为代码风格调整提交PR
• 未经讨论的大型重构
• 提交非原创代码（需签署CLA）
• 修改许可证相关文件
• 未经讨论变更公共API或UI

自动化检查详解

每个PR必须通过以下检查：

1. WinUI-Public-MUX-PR

核心验证流程包括：

• 代码构建验证
• 自动化测试执行
• 生成对应NuGet包

2. license/cla

确认贡献者已签署贡献者许可协议

其他可能遇到的检查

WinUI-Public-MUX-CI流程会在合并后执行，额外验证：

• Debug构建
• ARM平台兼容性

提交信息规范

提交信息应采用以下格式：

简要总结（50字符以内）

详细描述变更内容，与总结空一行。
每行不超过72字符。

如果是修复issue，再空一行后注明。

Fix #42

示例：

修复按钮点击区域计算错误

修正了Button控件中点击区域计算的逻辑错误，现在能正确处理
带有Padding属性的情况。添加了相关测试用例验证修复。

Fix #1234

高级建议

1. 对于复杂功能，建议分阶段提交：

   • 先提交架构设计
   • 然后逐步实现核心功能
   • 最后完善测试和文档

2. 与维护团队保持沟通：

   • 及时响应代码审查意见
   • 明确标记需要特别关注的变更部分
   • 对争议点提供详细解释和背景

3. 测试策略：

   • 单元测试覆盖核心逻辑
   • 交互测试验证UI行为
   • 性能测试确保不影响现有表现

通过遵循这些规范，你的贡献将更容易被项目接受，也能帮助维护WinUI项目的高质量标准。

microsoft-ui-xaml Windows UI Library: the latest Windows 10 native controls and Fluent styles for your applications 项目地址: https://gitcode.com/gh_mirrors/mi/microsoft-ui-xaml