init-project

Files (11)

• CHANGELOG.md
• README.md
• SKILL.md
• config.yaml
• generate.py · scripts/
• test_console_encoding.py · scripts/
• AGENTS.md.template · templates/
• CHANGELOG.md.template · templates/
• CLAUDE.md.template · templates/
• README.md.template · templates/
• gitignore.yaml · templates/

SKILL.md (first lines)

# Init Project

## 目标

当用户明确要求初始化项目、创建项目指令文件、生成 AGENTS.md，或为已有项目补齐 AI 协作规范时使用。本 Skill 分析项目结构，并生成或更新适用于当前项目的标准化协作文档与基础目录。

## 流程

### 输入

输入为目标项目根目录及用户选择的初始化模式；可选输入包括项目名称/描述、工作流、输出开关、`--overwrite`、`--bac-file` 和 `--disable-bac`。输出路径必须位于当前项目目录内，现有治理文件和用户自定义章节应先识别再合并。

### 执行步骤

#### 目标与边界

为当前项目生成标准 AI 协作文档，让 Claude Code / OpenAI Codex CLI 等工具理解项目目标、工程原则、变更记录规则与协作边界。

只允许在当前工作目录及其子目录内创建或修改文件。禁止写入父目录、其它项目、系统目录或用户级配置。脚本会在写入前校验输出路径，失败时立即停止。

#### 核心约束

- `AGENTS.md` 是唯一需要长期手动维护的通用指令源；`CLAUDE.md` 只做 Claude Code 适配，并通过 `@./AGENTS.md` 自动引用。
- 生成模板统一放在 `init-project/templates/`：`AGENTS.md.template`、`CLAUDE.md.template`、`README.md.template`、`CHANGELOG.md.template`、`gitignore.yaml`。
- 配置统一放在 `init-project/config.yaml`，版本号以 `skill_info.version` 为准；当前 BAC 配置在 `bac_contribution`。
- 完整初始化必须补齐 `docs/`、`docs/plans/` 与 `skills/`；`skills/` 只托管项目专属 Agent Skills。
- `skills/` 中的 Agent Skill 必须遵循 `huangwb8/skills` 仓库的 `AGENTS.md`，并配合该仓库的 `docs/templates` 使用；不得把通用 Skill 或无关项目代码放入其中。
- 代码变化导致 `docs/` 中非 `plans/` 文档过时时，生成的项目指令必须要求同步更新。
- 影响项目行为、结构、工作流、工程原则、指令文件或关键配置的变更，必须写入 `CHANGELOG.md` 的 `[Unreleased]`。

#### BAC 贡献记录

默认基于 `bensz-auto-contribution` / `bac` 记录人类、AI 与工具贡献证据：

- 默认仓库：`https://github.com/huangwb8/bensz-auto-contribution`
- 默认安装源：`git+https://github.com/huangwb8/bensz-auto-contribution.git`
- 默认文件：`docs/contribution.bac`
- Python 要求：`config.yaml:bac_contribution.min_python_version`，当前为 `3.10`
- 默认开启；用户可随时通过 `--disable-bac` 显式关闭。关闭时生成的文档也必须说明当前已关闭且可重新启用。
- 用户通过 `--bac-file` 指定项目内其它路径时，以用户指定为准；禁止把 `.bac` 文件写到项目目录外。

BAC 是过程记录与辅助审计材料，不替代最终署名、责任或合规判断；不得记录敏感密钥、完整私有提示词或无关个人隐私。

#### 推荐执行

在目标项目根目录运行：

```bash
python3 init-project/scripts/generate.py --auto
```

常用参数：

```bash
# 覆盖/强制更新已有文件
python3 init-project/scripts/generate.py --auto --overwrite

# 指定 BAC 文件，必须位于项目目录内
python3 init-project/scripts/generate.py --auto --bac-file docs/audit/contribution.bac

# 显式关闭默认 BAC 初始化
python3 init-project/scripts/generate.py --auto --disable-bac

# 只生成单类文档 / 跳过可选输出
python3 init-project/scripts/generate.py --auto --only-readme
python3 init-project/scripts/generate.py --auto --only-changelog
python3 init-project/scripts/generate.py --auto --skip-readme --skip-gitignore
```

手动模式只在用户明确给出项目信息时使用：

```bash
python3 init-project/scripts/generate.py \
  --project-name "my-project" \
  --project-description "数据科学项目" \
  --workflow "数据获取 → 分析 → 可视化"
```

#### 自动模式流程

`--auto` 会依次完成：

1. 验证输出目录必须位于当前工作目录内。
2. 分析项目：从 README 提取名称/描述，按标志文件识别项目类型，生成最多 2 层目录树。
3. 检测默认语言，失败时回退到简体中文。
4. 完整初始化时创建 `docs/` 与 `docs/plans/`。
5. 按配置决定是否启用 BAC：检查 Python 与 `bac` 包，必要时安装，初始化或验证 `.bac` 文件。
6. 生成或智能合并 `AGENTS.md`、`CLAUDE.md`。
7. 按条件生成 `README.md`、`CHANGELOG.md`、`.gitignore`。
8. 输出生成文件、目录与项目分析摘要。

项目类型识别标志：Python（`pyproject.toml`、`requirements.txt` 等）、Web（`package.json` 等）、Rust（`Cargo.toml`）、Go（`go.mod`）、Java（`pom.xml`/Gradle）、数据科学（`*.ipynb`、`*.R`、`environment.yml`）、文档（`docs/`、`mkdocs.yml`、`docusaurus.config.js`）。

#### 智能合并策略

当 `AGENTS.md` 或 `CLAUDE.md` 已存在时，默认智能合并而非直接覆盖：保留用户自定义的 `## 项目目标`、`## 核心工作流`、`## 变更边界` 及非标准章节；更新工程原则、默认语言、平台适配、`AGENTS.md` 必需章节与 `CLAUDE.md` 的 `@./AGENTS.md` 引用。`AGENTS.md` 中历史遗留的 `## 目录结构` 会被丢弃，避免回填为自定义章节；合并不符合预期时提示用户用 `--overwrite`。

#### .gitignore 策略

从 `templates/gitignore.yaml` 读取规则；缺少 PyYAML 或配置损坏时使用默认规则兜底。安全优先，默认忽略系统文件、IDE 配置、日志、临时文件、环境变量、密钥、凭证目录和常见构建/缓存产物。已有 `.gitignore` 在覆盖模式下会保留用户自定义规则。

### 输出

#### 输出文件

- `AGENTS.md`：跨平台通用项目指令，Single Source of Truth；必生成，智能合并。
- `CLAUDE.md`：Claude Code 适配层，核心为 `@./AGENTS.md`；必生成，智能合并。
- `README.md`、`CHANGELOG.md`、`.gitignore`：按需生成；`--overwrite` 可覆盖/合并。项目变更必须维护 `CHANGELOG.md`。
- `docs/`、`docs/plans/`、`skills/`：完整初始化时自动补齐；计划文档固定放在 `./docs/plans/`，项目专属 Agent Skills 固定放在 `./skills/`。
- `docs/contribution.bac`：默认 BAC 账本；`--bac-file` 可改，`--disable-bac` 可关。

### 输出管理

#### BenszAPI 任务工作区


### 校验

#### 交付前检查

From huangwb8/skills, MIT.

More from huangwb8/skills