Windows-Auto-Night-Mode贡献指南：如何参与开源项目开发
Windows-Auto-Night-Mode贡献指南：如何参与开源项目开发
项目概述
Windows-Auto-Night-Mode是一款能够根据时间自动切换Windows系统深色/浅色主题的开源工具，支持Windows 10和Windows 11系统。项目采用GNU General Public License v3.0协议开源，所有贡献将遵循该协议进行授权。
主要功能包括：
- 基于日出日落时间自动切换主题
- 桌面壁纸、鼠标光标、强调色切换
- Office主题切换和Windows .theme文件支持
- 自定义脚本执行和键盘快捷键
项目结构采用模块化设计，主要包含以下核心组件：
- AutoDarkModeApp：主应用程序界面，包含MainWindow.xaml和各设置页面
- AutoDarkModeLib：核心功能库，包含AdmConfig.cs配置管理和Helper.cs工具类
- AutoDarkModeSvc：后台服务，包含ThemeManager.cs主题管理和WallpaperHandler.cs壁纸处理
开发环境准备
必要工具
- .NET Framework（版本需匹配项目要求）
- Visual Studio 2022（推荐）或其他C#开发环境
- Git版本控制工具
代码获取
通过以下命令克隆项目仓库：
git clone https://gitcode.com/gh_mirrors/win/Windows-Auto-Night-Mode.git项目构建
- 打开解决方案文件[Windows Auto Dark Mode.sln](https://gitcode.com/gh_mirrors/win/Windows-Auto-Night-Mode/blob/913f0071f0a0f8ea25cbd97e3897ac0fdeb6d33c/Windows Auto Dark Mode.sln?utm_source=gitcode_repo_files)
- 还原NuGet包（Visual Studio通常会自动完成）
- 选择适当的构建配置（Debug/Release）
- 构建整个解决方案
贡献流程
分支策略
master：主分支，保持稳定可发布状态develop：开发分支，新功能在此集成- 功能分支：从
develop分出，命名格式建议为feature/功能名称或bugfix/问题描述
提交规范
提交信息应清晰描述变更内容，建议格式：
[类型] 简短描述 详细说明（可选） 相关Issue: #123类型包括：
feat：新功能fix：错误修复docs：文档更新style：代码格式调整refactor：代码重构test：测试相关chore：构建/依赖管理
代码提交流程
- 创建并切换到功能分支：
git checkout develop git pull git checkout -b feature/your-feature-name- 进行开发并提交变更：
git add . git commit -m "[feat] 添加XX功能" git push -u origin feature/your-feature-name- 在GitCode上创建合并请求（MR），目标分支选择
develop
代码规范
C#编码规范
项目遵循标准C#编码规范，主要包括：
- 使用PascalCase命名类、方法和属性
- 使用camelCase命名局部变量和参数
- 代码缩进使用4个空格
- 每个类单独放在一个文件中
- 使用XML注释为公共成员提供文档
代码风格检查
建议使用EditorConfig保持代码风格一致，项目根目录已包含相关配置。
功能开发指南
添加新设置项
以添加一个新的主题切换选项为例：
- 在配置模型中添加属性（AdmConfig.cs）：
public bool NewFeatureEnabled { get; set; } = false;- 创建设置界面元素（如PageSettings.xaml）：
<CheckBox Content="启用新功能" IsChecked="{Binding NewFeatureEnabled}"/>- 在视图模型中添加绑定属性
- 在主题切换逻辑中应用新设置（ThemeManager.cs）
扩展主题切换组件
项目的主题切换功能通过组件化设计实现，新组件应实现ISwitchComponent.cs接口：
public class NewThemeComponent : ISwitchComponent { public void Switch(Theme newTheme, SwitchEventArgs e) { // 实现切换逻辑 } // 其他接口成员实现 }然后在组件管理器中注册（ComponentManager.cs）。
测试指南
单元测试
项目测试代码位于Tests目录（如未创建可自行添加），使用Visual Studio的测试框架进行单元测试。
功能测试
新功能开发完成后应进行全面测试，包括：
- 正常功能测试
- 边界条件测试
- 兼容性测试（Windows 10和Windows 11不同版本）
提交测试报告
测试中发现的问题应在MR中详细说明，包括：
- 测试环境（系统版本、硬件配置等）
- 测试步骤
- 预期结果和实际结果
- 问题复现方法（如适用）
文档贡献
用户文档
用户文档位于Readme/目录，主要包括：
- 功能说明
- 使用教程
- 常见问题解答
API文档
公共API应提供XML注释，可使用工具生成HTML文档。
翻译贡献
项目支持多语言，翻译文件位于AutoDarkModeLib/Properties/目录，如Resources.zh-hans.resx为简体中文资源文件。
添加新语言翻译：
- 复制
Resources.resx并命名为Resources.语言代码.resx - 翻译各字符串资源
- 提交翻译文件
问题反馈与处理
报告Bug
通过Issue报告Bug时，应包含：
- 详细的问题描述
- 复现步骤
- 预期行为和实际行为
- 截图或录屏（如适用）
- 环境信息（系统版本、应用版本等）
处理Issue
- 确认Issue有效且未被处理
- 分配给自己或请求分配
- 进行修复并提交PR，引用相关Issue
- 修复验证后关闭Issue
社区交流
项目使用Telegram群组进行交流（链接见项目README），可在群中讨论开发问题、功能建议等。
贡献者名单
所有贡献者将在项目README的贡献者部分列出，感谢您的贡献！
总结
本指南介绍了参与Windows-Auto-Night-Mode项目开发的基本流程和规范。遵循这些指南将有助于您的贡献被顺利接受和合并。如有任何疑问，欢迎在项目Issue中提问或加入社区交流。
期待您的贡献，让Windows-Auto-Night-Mode变得更好！
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考