# 贡献指南感谢您对CloudLens项目感兴趣！我们欢迎所有形式的贡献。 ## 🚀 如何开始 ### 1. Fork项目点击GitHub页面右上角的"Fork"按钮 ### 2. Clone到本地 ```bash git clone https://github.com/YOUR_USERNAME/cloudlens.git cd cloudlens ``` ### 3. 设置开发环境 ```bash # 创建虚拟环境 python3 -m venv .venv source .venv/bin/activate # Linux/Mac # .venv\Scripts\activate # Windows # 安装依赖 pip install -r requirements.txt # 安装开发依赖 pip install pytest pytest-cov black flake8 mypy bandit pre-commit # 激活pre-commit hooks pre-commit install ``` ## 📝 开发流程 ### 1. 创建分支 ```bash git checkout -b feature/your-feature-name # 或 git checkout -b fix/bug-description ``` ### 2. 编写代码遵循项目的代码规范（见下方） ### 3. 运行测试 ```bash # 运行所有测试 pytest # 运行特定测试文件 pytest tests/core/test_filter_engine.py # 查看覆盖率 pytest --cov=core --cov=providers --cov-report=html ``` ### 4. 代码检查 ```bash # 格式化代码 black . # 检查代码风格 flake8 . # 类型检查 mypy core providers # 安全扫描 bandit -r core providers ``` ### 5. 提交代码 ```bash git add . git commit -m "feat: add new feature description" git push origin feature/your-feature-name ``` ### 6. 创建Pull Request 在GitHub上创建PR，填写详细描述 ## 🎨 代码规范 ### Python代码风格 - 遵循 **PEP 8** 规范 - 使用 **Black** 格式化（行长度100） - 使用 **Type Hints** 进行类型标注 - 编写清晰的**Docstrings** ```python def example_function(param1: str, param2: int) -> bool: \"\"\" 函数功能简短描述 Args: param1: 参数1说明 param2: 参数2说明 Returns: 返回值说明 Raises: ExceptionType: 异常说明 \"\"\" pass ``` ### 提交信息规范使用[Conventional Commits](https://www.conventionalcommits.org/)格式： ``` ():