diff --git a/.coverage b/.coverage new file mode 100644 index 0000000..f993efd Binary files /dev/null and b/.coverage differ diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..7f0c8ca --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,216 @@ +# 贡献指南 + +> **AI 时代你的第二大脑** + +感谢你对 ByteBrain 项目感兴趣！ + +--- + +## 开发环境设置 + +### 1. 克隆仓库 +```bash +git clone https://github.com/your-username/ByteBrain.git +cd ByteBrain +``` + +### 2. 创建虚拟环境 +```bash +python -m venv venv +source venv/bin/activate # Linux/Mac +# 或 +venv\Scripts\activate # Windows +``` + +### 3. 安装依赖 +```bash +# 安装开发依赖 +make install-dev + +# 验证安装 +python -m pytest tests/unit/ -v +``` + +--- + +## 开发工作流 + +### 1. 创建分支 +```bash +git checkout -b feature/your-feature-name +``` + +### 2. 编写代码 +- 遵循项目的 [代码规范](#代码规范) +- 添加必要的类型注解 +- 编写单元测试 +- 确保代码符合 ByteBrain 的设计哲学 + +### 3. 运行测试 +```bash +# 运行单元测试 +make test-unit + +# 运行集成测试 +make test-integration + +# 运行所有测试 +make test +``` + +### 4. 代码质量检查 +```bash +# 格式化代码 +make format + +# 运行代码检查 +make lint +``` + +### 5. 提交代码 +```bash +git add . +git commit -m "feat: 描述你的变更" +git push origin feature/your-feature-name +``` + +### 6. 创建 Pull Request +在 GitHub 上创建 PR，填写 PR 模板 + +--- + +## 代码规范 + +### Python 代码 +- **PEP 8 标准**：遵循 PEP 8 代码风格指南 +- **类型提示**：使用 Python 类型提示增强代码可读性和IDE支持 +- **命名规范**： + - 类名：使用 `CamelCase` + - 函数和变量：使用 `snake_case` + - 常量：使用 `UPPERCASE_WITH_UNDERSCORES` + - 私有属性和方法：使用 `_single_leading_underscore` +- **文档字符串**：使用 Google 风格的文档字符串 +- **格式化工具**：使用 Black 格式化代码 +- **代码检查**：遵循 Flake8 检查 + +### 文档 +- 使用 Markdown 格式 +- 代码示例要可运行 +- 英文术语首字母大写 +- 保持与 README.md 风格一致 + +--- + +## 提交信息规范 + +使用 Conventional Commits 格式： + +``` +(): + + + +