61 lines (45 loc) · 1.32 KB

贡献指南 | Contributing Guide

感谢你对 InsightPulse 的关注！欢迎贡献代码、报告问题或提出建议。

开发环境设置

克隆仓库

git clone https://github.com/gitstq/InsightPulse.git
cd InsightPulse

安装开发依赖
```
pip install -e ".[dev]"
```
运行测试
```
pytest tests/ -v
```

代码规范

Python 3.10+ 兼容
遵循 PEP 8 编码规范
所有公共函数必须有 docstring
新功能必须附带测试用例
零外部运行时依赖原则（仅使用 Python 标准库）

提交规范

遵循 Angular 提交规范：

feat(sources): 新增抖音数据源
fix(core): 修复缓存过期时间计算错误
docs: 更新 README 安装说明
test: 添加 NLP 分析器单元测试
refactor(nlp): 优化关键词提取算法

添加新数据源

在 src/insightpulse/sources/ 下创建新文件
继承 BaseSource 类，实现 search() 方法
在 registry.py 中注册新数据源
添加对应的测试用例

问题报告

请使用 GitHub Issues 提交问题，包含以下信息：

问题描述
复现步骤
期望行为
实际行为
运行环境（Python 版本、操作系统）

许可证

本项目采用 MIT 许可证。贡献的代码将同样以 MIT 许可证发布。