# Contributing

感谢给这个个人站点补充资源。

## 如何贡献资源

1. 在对应的 `data/*.json` 中新增条目，保持 JSON 合法。
2. 按统一字段填写资源信息（见下方 schema）。
3. 优先收录文档完善、仍在维护、自己也会反复用到的项目。
4. 提交 PR 时说明分类、推荐理由与适用场景。

## 资源字段 Schema

```json
{
  "id": "unique-kebab-id",
  "name": "Resource Name",
  "github": "https://github.com/org/repo",
  "website": "https://example.com",
  "description": "Short description for enterprise teams.",
  "category": "AI Coding",
  "tags": ["Claude", "MCP"],
  "stars": 1000,
  "forks": 100,
  "license": "MIT",
  "language": "TypeScript",
  "updated": "2026-06-01",
  "official": false,
  "rating": 4,
  "docs": "https://example.com/docs",
  "examples": "https://github.com/org/repo/tree/main/examples",
  "enterprise": true,
  "scenario": "PR review / unit test generation"
}
```

## 推荐等级

| rating | 含义 |
| ------ | ---- |
| 5 | 强烈推荐，企业可优先评估 |
| 4 | 推荐，适合多数团队 |
| 3 | 可用，按场景选型 |
| 2 | 实验性 / 早期项目 |
| 1 | 仅作参考 |

## 本地预览

在仓库根目录启动静态服务后打开网站：

```bash
npx serve .
# 访问 http://localhost:3000/website/
```

或：

```bash
python -m http.server 8080
# 访问 http://localhost:8080/website/
```

## 行为准则

- 不提交恶意、侵权或明显误导性资源
- 不批量刷无关项目
- 描述保持客观、自写短简介，勿粘贴官方文档大段原文
- 勿提交官方 Logo、商标图或未授权宣传素材
- 「official: true」仅用于上游确为官方的项目，不代表本站获得授权

## 更正与下架

本站为个人非官方整理。权利人或维护者如认为某条目不准确、不当或需下架：

1. 在仓库提交 Issue，说明条目 `id`、原因与诉求
2. 或直接提交 PR 修正 / 删除对应 JSON
3. 收到有效通知后会尽快处理

## 行为边界

- 本项目与所列产品、厂商无隶属或合作关系
- 不镜像、不托管第三方源码或文档全文
- 元数据（Stars 等）为快照，可能滞后