Files
claude-code-skills/docs/superpowers/plans/2026-06-23-project-structure.md
2026-06-23 14:41:04 +08:00

211 lines
4.1 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 项目结构初始化 实现计划
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
**Goal:** 为 claude-code-skills 仓库建立可扩展的项目结构(.gitignore、CLAUDE.md、skills/README.md、更新 README.md
**Architecture:** 四个独立文件,无依赖关系,可按任意顺序创建。均为纯文本文件,无需测试。
**Tech Stack:** Markdown, Git
---
### Task 1: 创建 `.gitignore`
**Files:**
- Create: `.gitignore`
- [ ] **Step 1: 创建 .gitignore 文件**
```gitignore
# IDE
.vscode/
.idea/
*.swp
*.swo
# OS
.DS_Store
Thumbs.db
# Claude Code
.claude/backups/
```
- [ ] **Step 2: 提交**
```bash
git add .gitignore
git commit -m "添加 .gitignore"
```
---
### Task 2: 创建 `skills/README.md`
**Files:**
- Create: `skills/README.md`
- [ ] **Step 1: 创建 skills 目录和 README.md**
```bash
mkdir -p skills
```
```markdown
# 技能列表
> 使用 Claude Code + DeepSeek v4
## 安装
```bash
git clone https://git.geyoyo.top/glj/claude-code-skills.git ~/.claude/skills
```
## 可用技能
暂无技能,待添加。
```
- [ ] **Step 2: 提交**
```bash
git add skills/README.md
git commit -m "添加技能索引文件"
```
---
### Task 3: 创建 `CLAUDE.md`
**Files:**
- Create: `CLAUDE.md`
- [ ] **Step 1: 创建 CLAUDE.md**
```markdown
# CLAUDE.md
本仓库为 Claude Code Skills 集合,托管于 Giteagit.geyoyo.top/glj/claude-code-skills.git),为 Claude Code + DeepSeek v4 提供技能扩展。
## 仓库约定
- 文档和提交信息使用**简体中文**
- 技能目录命名使用 **kebab-case**(如 `code-review``spring-boot`
- 保持扁平结构,不按领域分层
## 技能开发规范
### 目录结构
```
skills/<skill-name>/
└── SKILL.md
```
### SKILL.md 格式
```markdown
---
name: <kebab-case-name>
description: <一句话描述>
---
# <技能名称>
<技能内容>
```
- `name` 需与目录名一致
- `description` 用简体中文,一句话说明技能用途
### 添加技能流程
1.`skills/` 下创建技能目录和 `SKILL.md`
2. 更新 `skills/README.md` 的技能列表
3. 提交并推送到远程
## 提交规范
- 提交信息用简体中文,格式:`<动词>: <简要描述>`,如 `添加 xxx 技能`
- 每次提交聚焦一个变更
```
- [ ] **Step 2: 提交**
```bash
git add CLAUDE.md
git commit -m "添加 CLAUDE.md 开发指南"
```
---
### Task 4: 更新 `README.md`
**Files:**
- Modify: `README.md`
- [ ] **Step 1: 更新 README.md**
当前内容(仅供参考,不要直接复制整篇——在实际执行时读取最新内容后做精确替换):
将幂等安装部分修正(原文 `claude-codec-skills` 有拼写错误),并在末尾添加指向 `skills/README.md` 的链接:
```markdown
# Claude Code Skills
Claude Code 技能集合,为 Claude Code + DeepSeek v4 提供专业领域的能力扩展。
## 快速开始
通过 Claude Code + DeepSeek v4 一键安装助手自动安装,或手动克隆:
```bash
git clone https://git.geyoyo.top/glj/claude-code-skills.git ~/.claude/skills
```
## 技能结构
每个技能是一个包含 `SKILL.md` 文件的子目录:
```
skills/
├── skill-name/
│ └── SKILL.md # 技能定义文件
└── README.md # 技能索引
```
## 可用技能
详见 [技能列表](skills/README.md)。
## 添加新技能
1. 在此仓库中创建新目录
2. 添加 `SKILL.md` 文件
3. 更新 `skills/README.md`
4. 提交并推送
更多详情见 [Claude Code Skills 文档](https://docs.anthropic.com/en/docs/claude-code/skills)。
```
**说明:** 原文 `claude-codec-skills` 有拼写错误(多了一个 c),修正为 `claude-code-skills`;目录结构中增加 `README.md` 节点;新增"可用技能"小节链接到技能索引;安装路径统一为 Linux/macOS 风格。
- [ ] **Step 2: 提交**
```bash
git add README.md
git commit -m "完善 README.md:修正链接、添加技能索引引用"
```
---
### Task 5: 最终推送
- [ ] **Step 1: 推送到远程**
```bash
git push origin master
```