Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (36 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 1.22 KB
Raw

Contributing to OpenWebIntel

感谢你的兴趣！本文档说明如何参与贡献。

开发环境

# 克隆你的 fork
git clone https://github.com/YOUR_USERNAME/open-web-intel-agent.git
cd open-web-intel-agent

# 安装开发依赖
python -m venv .venv
source .venv/bin/activate
pip install -c constraints.txt -e ".[dev]"

代码规范

  • Python 3.10+，带类型标注
  • 每个渠道是 open_web_intel/channels/ 下的单个文件，继承 BaseChannel
  • 渠道契约：必须实现 can_handle(url) 和 check(config)
  • 使用 loguru 记录日志、rich 输出 CLI

提交前检查

# 测试
pytest tests/ -v

# 代码风格
ruff check open_web_intel tests

# 类型检查
mypy open_web_intel

提交流程

  1. 从 main 新建分支
  2. 一次提交做一件事，格式 type(scope): message
  3. 提交前跑通全部测试
  4. 提 PR 到 main

设计原则

  • 只读公开内容 — 不接受需要登录 Cookie / 浏览器会话桥接的渠道
  • 数据不出本机 — 不引入第三方数据服务（阅读器、搜索、转录代理）
  • 胶水层 — 只路由和调用上游工具，不重新实现它们
  • 默认安全 — 安装默认只读，写系统必须显式授权