Skip to content

Contributing

Jump to bottom
皮卡超人 edited this page Nov 25, 2025 · 1 revision

贡献指南

感谢您对 WodToolKit 项目的关注！我们欢迎所有形式的贡献。

如何贡献

报告问题

如果您发现了 bug 或有功能建议，请：

  1. 在 GitHub Issues 中搜索是否已有相关问题
  2. 如果没有，创建新的 Issue，详细描述：
    • 问题描述
    • 复现步骤
    • 预期行为
    • 实际行为
    • 环境信息（.NET 版本、操作系统等）

提交代码

  1. Fork 项目仓库

    • 在 GitHub 上点击 "Fork" 按钮创建您自己的仓库副本

  2. 克隆仓库

    git clone https://github.com/your-username/WodToolKit.git
cd WodToolKit

  3. 创建分支

    git checkout -b feature/your-feature-name

  4. 实现功能或修复问题

    • 请确保代码风格与项目保持一致
    • 为新功能添加适当的测试用例
    • 更新相关文档

  5. 提交更改

    git add .
git commit -m "描述您的更改"

  6. 推送到您的 Fork

    git push origin feature/your-feature-name

  7. 创建 Pull Request

    • 在 GitHub 上导航到原始仓库
    • 点击 "New Pull Request" 按钮
    • 选择您的分支并提交 PR
    • 请在 PR 描述中详细说明您的更改内容和目的

开发规范

代码风格

  • 遵循 C# 标准代码约定
  • 使用有意义的变量和方法名
  • 为公共方法和类添加 XML 文档注释

测试

  • 新功能应包含单元测试
  • 确保所有测试通过
  • 保持或提高代码覆盖率

兼容性

  • 确保代码与 .NET Standard 2.1 兼容
  • 测试在不同平台上的兼容性

文档

  • 更新相关文档（README、Wiki 等）
  • 为新功能添加使用示例
  • 更新 API 文档

代码审查

所有 Pull Request 都会经过代码审查。审查过程可能包括：

  • 代码质量和风格检查
  • 功能正确性验证
  • 性能影响评估
  • 文档完整性检查

行为准则

  • 尊重所有贡献者
  • 建设性的反馈和讨论
  • 专注于项目目标

许可证

通过贡献代码，您同意您的贡献将在 MIT 许可证下发布。

联系方式

如有任何问题，请通过以下方式联系：

感谢您的贡献！

Clone this wiki locally