Skip to content

Latest commit

 

History

History
72 lines (54 loc) · 1.36 KB

File metadata and controls

72 lines (54 loc) · 1.36 KB

🤝 贡献指南 | Contributing Guide

感谢你对 CSIPulse 的关注!我们欢迎所有形式的贡献。

Thank you for your interest in CSIPulse! We welcome all forms of contributions.


📋 贡献流程 | Contribution Workflow

1. Fork & Clone

git clone https://github.com/你的用户名/CSIPulse.git
cd CSIPulse
pip install -r requirements.txt

2. 创建分支

git checkout -b feature/your-feature-name

3. 开发 & 测试

# 运行测试
python -m pytest tests/ -v

# 确保所有测试通过

4. 提交代码

遵循 Angular 提交规范:

前缀 用途
feat: 新增功能
fix: 修复问题
docs: 文档更新
refactor: 代码重构
test: 测试相关
chore: 构建/工具相关
git commit -m "feat: 添加新的CSI数据格式支持"

5. 推送 & PR

git push origin feature/your-feature-name

然后在 GitHub 上创建 Pull Request。


📝 代码规范 | Code Style

  • Python 3.8+ 兼容
  • 使用类型注解(Type Hints)
  • 中文+英文双语注释
  • 函数/类添加 docstring
  • 遵循 PEP 8 编码规范

🐛 问题反馈 | Issue Reporting

提交 Issue 时请包含:

  • 问题描述
  • 复现步骤
  • 期望行为
  • 实际行为
  • 环境信息(Python版本、操作系统等)