CONTRIBUTING.md

Contributing to AI Arsenal

感谢你对 AI Arsenal 的兴趣！我们欢迎任何形式的贡献，让这个"代码军火库"变得更强大。

如何贡献

1. 上传新模块/文件

• Fork 本仓库
• 在对应货架文件夹下创建新文件（或子文件夹）
• 必须在文件顶部添加标准化头部注释（见下方模板）
• 提交 PR，标题格式：[语言/分类] 简短描述
  • 示例：[solidity/lending] 添加动态利率模型Facet

2. 改进现有文件

• 修复 bug、优化 gas、加测试、完善文档
• PR 标题：[fix/update] 文件路径 - 简短描述

3. 添加/完善蓝图

• 在 blueprints/ 下新增或修改套装
• 必须包含 README.md（整体说明书 + 组装步骤）

4. 反馈 & 需求

• 提 Issue：bug 报告、想要的模块、蓝图需求
• 用 Discussions 讨论新货架想法、命名规范等

分支命名

feature/<name>     # 新功能/新模块
fix/<name>         # Bug 修复
docs/<name>        # 文档改进

Review 流程

1. 提交 PR 后，maintainer 会在 3 个工作日内进行初步审核
2. 重点审核：头部注释完整性、代码可复用性、是否有安全隐患
3. 审核通过后合并到 main

文件头部注释模板（必须遵守）

根据语言使用对应的注释语法，字段保持一致：

Solidity / JavaScript / TypeScript:

// --- AI Arsenal Module Header ---
// name: LendingCoreFacet
// version: 1.0
// language: Solidity
// dependencies: openzeppelin@5.0
// description: DeFi借贷核心逻辑Facet
// config_params: oracle_address, interest_model
// performance: gas<35k per call, coverage>90%
// assembly_guide: 在DiamondCut中添加此Facet
// license: MIT
// --- End Header ---

Python:

# --- AI Arsenal Module Header ---
# name: token_price_pipeline
# version: 1.0
# language: Python
# dependencies: requests, pandas
# description: 代币价格数据抓取管道
# config_params: api_key, token_list
# performance: ~2s per 100 tokens
# assembly_guide: 配置 .env 后直接运行
# license: MIT
# --- End Header ---