Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 3.32 KB

File metadata and controls

90 lines (61 loc) · 3.32 KB

贡献指南

感谢你对 AIShield 的兴趣!AIShield 是 AI Agent 安全与信任基础设施,每一个贡献都让 Agent 生态更安全。

如何贡献

1. 报告问题

2. 提交代码

环境准备

# 克隆仓库
git clone https://github.com/lm203688/aishield.git
cd aishield

# 创建虚拟环境(推荐)
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate

# 安装依赖(本项目零外部依赖,仅标准库)
# 但测试需要 pytest
pip install pytest

开发流程

  1. Fork 仓库 并创建分支:git checkout -b feature/你的功能
  2. 编写代码:遵循现有代码风格,保持零外部依赖(标准库 only)
  3. 运行测试:python tests/run_all.py
  4. 提交 PR:描述清楚改动内容和测试情况

代码规范

  • Python 3.10+ 兼容
  • 零外部依赖(requirements.txt 为空是设计选择)
  • 中文注释,英文变量名
  • 每个模块顶部包含功能说明和 API 路由文档
  • 线程安全:JSON 文件操作使用 threading.Lock

3. 贡献安全规则

AIShield 的核心是安全规则库。你可以:

  • 新增规则:在 scanner/rules/ 下添加规则,遵循 MCPxx-xxx 编号格式
  • 规则优化:提升现有规则的检测准确率,减少误报
  • 漏洞案例:提交真实漏洞案例,帮助我们训练更精准的检测

4. 文档贡献

  • 改进 README、API 文档
  • 撰写安全研究博客(发布到 aishield.tools/blog)
  • 翻译文档(我们计划支持多语言)

5. 社区参与

  • 加入 Discord
  • 在社交媒体分享 AIShield
  • 在 Awesome MCP Servers 列表中推荐我们

6. 范围纪律(Scope Discipline)

借鉴 heyclicky 的 AGENTS.md 约定——大代码库里 churn 比 bug 更贵:

  • 不擅自加超出请求范围的功能或重构。 只做被明确要求的改动;想扩功能先提 issue / 讨论。
  • 改动保持最小可用(MVP),避免顺手「顺带」重构不相关的模块。
  • 任何新能力都要说明它在「检测→动作→验证→告警」闭环中的位置,否则是半成品。
  • 详见 AGENTS.md 的核心不变量与贡献约定。

贡献者权益

  • 高质量贡献者将获得 GitHub 仓库的 Triage 权限
  • 核心贡献者将列入 CONTRIBUTORS 文件和官网致谢页
  • 安全规则贡献者将在规则库中署名

行为准则

请尊重每一位社区成员。我们遵循 Contributor Covenant 行为准则。

需要帮助?