AwesomeClaudeCode: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

AwesomeClaudeCode 是一个采用 单一数据源（SSOT） 架构的 Claude Code 资源汇聚项目。所有资源数据存储在 THE_RESOURCES_TABLE.csv 中，通过 Python 脚本自动生成 README.md。内容以简体中文为主，英文为辅。

Architecture

Data Flow

数据变更 → CSV 更新 → 脚本处理 → README 生成

Core Components

数据层 (Data Layer):

• THE_RESOURCES_TABLE.csv - 资源数据的唯一数据源（SSOT）。包含所有资源的元数据
• templates/categories.yaml - 分类定义的唯一数据源。定义13个主分类及其子分类
• templates/resource-overrides.yaml - 资源手动覆盖配置。用于特殊情况的数据覆盖

生成层 (Generation Layer):

• scripts/generate_readme.py - 核心生成脚本，从 CSV 生成 README.md
• scripts/generate_logo_svgs.py - 生成 SVG 图标和动画
• scripts/generate_ticker_svg.py - 生成滚动条 SVG

验证层 (Validation Layer):

• scripts/validate_csv.py - CSV 数据完整性验证
• scripts/validate_links.py - 链接有效性检查
• tests/ - 单元测试和集成测试

输出层 (Output Layer):

• README.md - 自动生成的项目主页，不要手动编辑
• assets/ - 生成的 SVG 图标和动画文件

Critical Rules

1. README.md 是只读的: 所有内容变更必须通过修改 CSV 或模板文件实现
2. CSV 是数据源: 直接修改 CSV 文件添加、更新或删除资源
3. categories.yaml 定义结构: 添加新分类时必须更新此文件
4. 先验证后生成: 修改后先运行 make validate 再运行 make generate

Common Commands

# 设置开发环境
make dev-setup

# 生成 README.md（从 CSV 数据）
make generate

# 验证 CSV 数据完整性
make validate

# 运行所有测试
make test

# 自动填充 GitHub 元数据
make auto-fill

# 快速生成并验证
make quick

# 查看所有可用命令
make help

Working with Resources

Adding a New Resource

1. 打开 CSV 文件: 编辑 THE_RESOURCES_TABLE.csv
2. 生成唯一 ID: 使用格式 {category_prefix}-{hash8}
   • 从 templates/categories.yaml 找到分类的 prefix
   • 生成 8 位哈希值（基于资源 URL 或名称）
3. 填写所有必填字段（见下方 CSV 字段参考）
4. 设置状态: IsActive=TRUE, IsPinned=FALSE (除非是特别重要的资源)
5. 运行验证: make validate
6. 生成 README: make generate
7. 提交变更: 提交 CSV 和生成的 README.md

Updating an Existing Resource

1. 在 THE_RESOURCES_TABLE.csv 中找到对应的行
2. 修改需要更新的字段
3. 如果需要覆盖某些验证规则，编辑 templates/resource-overrides.yaml
4. 运行 make validate && make generate
5. 提交变更