CONTRIBUTING.md

贡献指南

感谢您对 Rust Compression 项目的兴趣！我们欢迎各种形式的贡献，包括但不限于：

• 修复 bug
• 添加新功能
• 改进文档
• 优化性能
• 编写测试

贡献流程

1. 环境准备

1. 确保您已安装以下工具：

   • Rust 1.89.0 或更高版本
   • Cargo 包管理器
   • Git 版本控制工具

2. 克隆项目仓库：

git clone https://github.com/yourusername/rust_compression.git
cd rust_compression

3. 安装开发依赖：

cargo build

2. 创建分支

在开始工作前，创建一个新的分支：

git checkout -b feature/your-feature-name
# 或
# git checkout -b fix/your-bug-fix

3. 开发规范

代码规范

• 遵循 Rust 编码规范（RFC 1301）
• 使用 cargo clippy 检查代码质量
• 确保代码通过 cargo test 测试
• 保持代码风格一致，使用 cargo fmt 格式化代码

提交规范

• 提交信息应清晰、简洁，描述具体修改内容
• 提交信息格式：

  <类型>: <描述>
  
  <详细说明>（可选）
  

• 类型包括：
  • feat：新功能
  • fix：bug 修复
  • docs：文档更新
  • style：代码风格修改
  • refactor：代码重构
  • test：测试相关
  • chore：构建、依赖等其他修改

4. 测试

在提交代码前，确保所有测试都通过：

# 运行单元测试和集成测试
cargo test

# 运行 clippy 检查
cargo clippy

# 格式化代码
cargo fmt

5. 提交 Pull Request

1. 推送到远程仓库：

git push origin feature/your-feature-name

2. 在 GitHub 上创建 Pull Request：
   • 标题清晰描述修改内容
   • 详细描述修改的原因、实现方式和测试结果
   • 关联相关 issue（如果有）

6. 代码审查

• 项目维护者会审查您的代码
• 可能会提出一些修改建议
• 请及时回应反馈，进行必要的修改

7. 合并

• 当代码审查通过后，您的贡献将被合并到主分支
• 恭喜您！您的贡献已被项目采纳

开发资源

• Rust 官方文档
• Cargo 官方文档
• Clippy 文档
• Criterion 文档
• Thiserror 文档

行为准则

我们希望所有参与者都能在一个友好、尊重的环境中贡献代码。请：

• 尊重其他参与者的意见和贡献
• 接受建设性的批评
• 专注于项目的最佳利益
• 对其他参与者保持友善和同理心

联系方式

如果您有任何问题或建议，欢迎通过以下方式联系我们：

• GitHub Issues：https://github.com/yourusername/rust_compression/issues
• GitHub Discussions：https://github.com/yourusername/rust_compression/discussions

感谢您的贡献！