SOUI 贡献指南¶
感谢您对 SOUI 项目的关注和贡献！本指南将帮助您了解如何为 SOUI 项目贡献代码和文档。
贡献方式¶
您可以通过以下方式为 SOUI 项目做出贡献：
- 代码贡献：修复 bug、添加新功能、优化性能
- 文档贡献：完善文档、翻译文档、修正错误
- 问题反馈：提交 issue、提供复现步骤、协助测试
- 社区支持：回答问题、分享经验、推广项目
代码贡献流程¶
1. 准备工作¶
在开始贡献代码之前，请确保您：
- 熟悉 C++ 编程语言和 Windows 开发环境
- 了解 SOUI 框架的基本架构和设计原则
- 安装必要的开发工具（Visual Studio、Git 等）
2. Fork 项目¶
访问 SOUI GitHub 仓库 或 Gitee 仓库，点击 "Fork" 按钮创建您自己的仓库副本。
3. 克隆仓库¶
git clone https://github.com/soui4/soui
cd soui
4. 创建功能分支¶
git checkout -b feature/your-feature-name
建议使用以下命名规范： - feature/功能名称 - 新功能开发 - bugfix/问题描述 - Bug 修复 - enhancement/优化内容 - 性能优化或改进
5. 编写代码¶
在编写代码时，请遵循以下规范：
编码规范¶
- 遵循项目现有的代码风格
- 使用清晰的变量和函数命名
- 添加必要的注释说明复杂逻辑
- 确保代码具有良好的可读性和可维护性
提交信息规范¶
提交信息应清晰描述变更内容：
git commit -m "feat: 添加新功能描述"
git commit -m "fix: 修复某个bug的描述"
git commit -m "docs: 更新文档内容"
git commit -m "refactor: 重构某部分代码"
6. 测试代码¶
在提交代码前，请确保：
- 代码能够正常编译
- 相关功能经过充分测试
- 没有引入新的编译警告或错误
- 现有功能未被破坏
7. 推送代码¶
git push origin feature/your-feature-name
8. 创建 Pull Request¶
在 GitHub 或 Gitee 上创建 Pull Request，详细描述您的变更内容：
- 变更的背景和目的
- 实现方式和关键点
- 测试方法和结果
- 相关的 issue 编号（如果有）
文档贡献流程¶
SOUI 文档仓库地址：https://gitee.com/setoutsoft/soui-docs clone 仓库后，使用python来查看本在文档目录下，运行python scripts/docs.py build-all编译文档，然后运行python scripts/docs.py serve启动一个http服务，访问http://localhost:8008查看文档。
1. 文档结构¶
SOUI 文档采用 Markdown 格式编写，主要包含以下部分：
- 用户指南：介绍 SOUI 的基本使用方法
- 开发教程：深入讲解特定功能和高级特性
- API 文档：详细说明接口和类的使用方法
- 高级主题：介绍框架设计原理和最佳实践
- 附录：变更日志、贡献指南等
2. 编写规范¶
Markdown 格式规范¶
- 使用标准 Markdown 语法
- 保持文档结构清晰，合理使用标题层级
- 代码块应指定语言类型
- 使用列表和表格提高可读性
内容规范¶
- 语言表达清晰准确
- 技术术语使用一致
- 提供完整的示例代码
- 包含必要的注意事项和最佳实践
3. 文档贡献步骤¶
- Fork 并克隆文档仓库
- 创建文档分支
- 编写或修改文档内容
- 预览文档效果
- 提交 Pull Request
问题反馈指南¶
提交 Issue¶
当您发现 bug 或有功能建议时，可以通过以下步骤提交 Issue：
- 搜索是否已有相关 Issue，避免重复提交
- 使用清晰的标题描述问题
- 详细描述问题现象和复现步骤
- 提供环境信息（操作系统、编译器版本等）
- 附加相关日志或截图
Bug 报告模板¶
**问题描述**
简要描述您遇到的问题
**复现步骤**
1.
2.
3.
**期望行为**
描述您期望的结果
**实际行为**
描述实际发生的情况
**环境信息**
- SOUI 版本：
- 操作系统：
- 编译器版本：
- 其他相关信息：
**附加信息**
任何有助于问题解决的信息
社区行为准则¶
为了维护良好的社区环境，请遵守以下准则：
- 尊重他人：保持友善和专业的态度
- 建设性讨论：专注技术问题，避免人身攻击
- 提供帮助：乐于帮助其他开发者解决问题
- 遵守法律：不发布违法或不当内容
- 保护隐私：不泄露个人或公司敏感信息
开发环境配置¶
Windows 开发环境¶
- 操作系统：Windows ⅞/10/11
- 开发工具：Visual Studio 2015 或更高版本
- 编译器：MSVC 编译器
- 版本控制：Git
项目构建¶
# 克隆项目
git clone https://github.com/soui4/soui.git
# 打开解决方案文件
# 使用 Visual Studio 打开 soui.sln
# 编译项目
# 选择合适的配置（Debug/Release）和平台（x86/x64）
代码审查流程¶
所有提交的 Pull Request 都会经过代码审查流程：
- 自动检查：CI 系统进行基础检查
- 人工审查：核心开发者进行代码审查
- 反馈修改：根据审查意见进行修改
- 合并代码：审查通过后合并到主分支
审查关注点： - 代码质量和规范性 - 功能实现的正确性 - 性能和安全性考虑 - 文档和注释的完整性
版本发布¶
SOUI 采用语义化版本控制：
- 主版本号：不兼容的重大变更
- 次版本号：向后兼容的功能新增
- 修订号：向后兼容的问题修正
发布流程： 1. 版本规划和功能确定 2. 代码冻结和测试 3. 发布候选版本 4. 正式版本发布 5. 文档更新
联系方式¶
如有任何疑问，您可以通过以下方式联系我们：
- GitHub Issues: https://github.com/soui4/soui/issues
- Gitee Issues: https://gitee.com/setoutsoft/soui4/issues
- 官方QQ群1：229313785
- 官方QQ群2：385438344
再次感谢您对 SOUI 项目的贡献！