如何参与 AtomUI 开源项目:从构建源码到贡献第一个控件的完整开发者指南

如何参与 AtomUI 开源项目:从构建源码到贡献第一个控件的完整开发者指南 如何参与 AtomUI 开源项目从构建源码到贡献第一个控件的完整开发者指南【免费下载链接】AtomUIAn enhancement and extension library for Avalonia, bringing the Ant Design design language, modern controls, theming, native integrations, and cross-platform UI capabilities to .NET desktop apps.项目地址: https://gitcode.com/gh_mirrors/at/AtomUIAtomUI 是一个为 Avalonia/.NET 桌面应用打造的 Ant Design 6 风格开源组件库提供企业级控件、主题 Token 系统、图标字体包与跨平台 UI 能力。本文是一份面向新手贡献者的 AtomUI 开源项目贡献指南你将学会如何搭建环境、构建源码、运行 Gallery 示例应用并完整走通「贡献第一个控件」的流程——从阅读规范、实现控件、补充测试到提交文档每一步都有可操作的说明。一、先认识项目结构你的贡献将落在哪里克隆仓库后你会看到这样几个核心区域详见项目根目录 AGENTS.md目录作用新手贡献机会src/AtomUI.Core/主题、Token、动画等运行时基础设施中高级src/AtomUI.Controls/跨平台基础控件中高级src/AtomUI.Desktop.Controls/桌面控件主包Button、DatePicker、Upload 等⭐ 控件贡献主战场controlgallery/AtomUIGallery/Gallery 示例应用每个控件有 ShowCase 页面⭐ 示例与文档tests/各模块单元测试与回归测试⭐ 修 bug 必备docs/架构、工程规范、控件研发文档⭐ 文档贡献工程规范的统一入口在 docs/engineering/overview.md贡献前建议先浏览一遍。二、环境准备三步装好开发环境AtomUI 要求.NET 10 SDK仓库 global.json 锁定10.0.300允许latestFeature向前滚动和 Avalonia 12.1.1支持 Windows、macOS 与 Linux 三端开发。安装 .NET 10 SDK到官方渠道下载 .NET 10.0.3xx 版本的 SDK 并验证dotnet --version。克隆仓库git clone https://gitcode.com/gh_mirrors/at/AtomUI.git cd AtomUI恢复依赖并构建dotnet restore AtomUI.slnx dotnet build AtomUI.slnx首次构建会触发AtomUI.Generator源码生成器Token、注册、本地化等样板代码均由其生成无需手写。三、运行源码启动 Gallery 看全部控件Gallery 是 AtomUI 的官方示例集跑起来它就是一块「活的文档」。桌面宿主位于controlgallery/AtomUIGallery.Desktop/dotnet run --project controlgallery/AtomUIGallery.Desktop/AtomUIGallery.Desktop.csproj启动后你可以逐个浏览 Button、Select、DataGrid、Upload 等 ShowCase 页面源码分布在controlgallery/AtomUIGallery/ShowCases/下按 DataDisplay、DataEntry、Navigation 等分类组织。页面结构规范见 docs/gallery/authoring/gallery-showcase-design-pattern.md。 想验证完整发布链路可参考controlgallery/AtomUIGallery.Desktop/scripts/PublishToLocal.ps1脚本它支持本地打包与 NativeAOT 发布。四、找到适合新手的贡献切入点第一次参与 AtomUI 开源项目不必一上来就写大控件推荐按难度递进修文档docs/controls/下每个控件都有overview.md、implementation.md、changelog.md补充说明是零风险起点。报 Issue / 修 Bug按 BUG Issue 规范 提交写清复现步骤、当前行为与期望行为。加 ShowCase 示例为已有控件补充演示用例熟悉 Gallery 页面模型。贡献新控件完成前三步后就可以挑战完整控件了。五、贡献第一个控件完整开发流程以src/AtomUI.Desktop.Controls/DatePicker/为参照一个标准控件包含五部分控件主文件DatePicker.cs承载公共 API、属性注册与事件Token 文件如DatePickerToken.cs定义专属设计 Token主题文件Themes/目录下的.axaml主题实现视觉样式本地化资源Localization/下的en_US.cs、zh_CN.cs等配套文档docs/controls/desktop/分类/控件/目录。动手前必读两份核心规范 控件研发标准规范API 兼容性红线不得擅改既有 public 契约、文件拆分建议、Semantic Part 设计 控件文档规范文档目录结构与写作要求。开发自检清单在tests/AtomUI.Desktop.Controls.Tests/对应目录补充测试按控件名建同名测试目录在 Gallery 新增 ShowCase 页面并注册同步更新控件docs目录与changelog.md遵循 AOT 编程规范——把 AOT 兼容性当作一等设计约束本地跑通针对性测试dotnet test tests/AtomUI.Desktop.Controls.Tests/AtomUI.Desktop.Controls.Tests.csproj --framework net10.0 git diff --check常见注意事项不要破坏 API重命名、删除任何public成员都视为破坏性变更必须事先在 PR 中说明理由✅AOT 优先避免反射与动态注册样板代码交给AtomUI.Generator源码生成器✅范围克制一次 PR 只做一件事理解受影响模块再改代码。六、常见问题速答Q构建失败提示 SDK 版本不匹配检查dotnet --version是否为 10.0.3xxglobal.json 已开启rollForward: latestFeature升级小版本即可。Q只想改 UI 效果要动 Token 吗先查该控件token.md视觉样式统一走 Token 驱动的主题系统不要在模板里写死颜色值。Q如何确认改动没有影响其他控件运行对应测试项目AGENTS.md中列出了四条常用dotnet test命令高风险改动建议再走一次 NativeAOT 发布验证。总结你的贡献之路 从环境准备到首个控件路径非常清晰装 .NET 10 → 克隆构建 → 跑起 Gallery → 从小改动练手 → 按规范交付完整控件。AtomUI 欢迎每一类贡献控件实现、Bug 修复、示例补全与文档完善都值得提交。现在打开终端clone 仓库开始你的第一次构建吧【免费下载链接】AtomUIAn enhancement and extension library for Avalonia, bringing the Ant Design design language, modern controls, theming, native integrations, and cross-platform UI capabilities to .NET desktop apps.项目地址: https://gitcode.com/gh_mirrors/at/AtomUI创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考