docs: 移除 .github 目录下的 AGENTS.md 文件
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
7ebf8087e4
commit
d0eaeed334
37
.github/AGENTS.md
vendored
37
.github/AGENTS.md
vendored
@ -1,37 +0,0 @@
|
||||
<!-- Parent: ../AGENTS.md -->
|
||||
<!-- Generated: 2026-04-07 | Updated: 2026-04-07 -->
|
||||
|
||||
# .github
|
||||
|
||||
## Purpose
|
||||
GitHub 配置目录,包含 CI/CD 工作流定义,自动化构建、测试和基准测试回归检测。
|
||||
|
||||
## Subdirectories
|
||||
|
||||
| Directory | Purpose |
|
||||
|-----------|---------|
|
||||
| `workflows/` | GitHub Actions 工作流定义 |
|
||||
|
||||
## For AI Agents
|
||||
|
||||
### Working In This Directory
|
||||
- CI 工作流在 PR 和推送时自动触发
|
||||
- 基准测试回归检测防止性能退化合并
|
||||
- 工作流使用 Makefile 命令执行任务
|
||||
|
||||
### Testing Requirements
|
||||
- CI 自动运行测试,无需手动触发
|
||||
- 本地可通过 `make check` 预验证
|
||||
|
||||
### Common Patterns
|
||||
- 工作流触发条件:push 到 master、PR 创建/更新
|
||||
- 测试步骤:fmt → lint → test → benchmark
|
||||
- 回归检测:比较基准测试结果差异
|
||||
|
||||
## Dependencies
|
||||
|
||||
### Internal
|
||||
- `../Makefile` - 构建命令定义
|
||||
- `../scripts/` - 辅助脚本
|
||||
|
||||
<!-- MANUAL: -->
|
||||
41
.github/workflows/AGENTS.md
vendored
41
.github/workflows/AGENTS.md
vendored
@ -1,41 +0,0 @@
|
||||
<!-- Parent: ../AGENTS.md -->
|
||||
<!-- Generated: 2026-04-07 | Updated: 2026-04-07 -->
|
||||
|
||||
# workflows
|
||||
|
||||
## Purpose
|
||||
GitHub Actions 工作流定义,自动化构建、测试和基准测试回归检测流程。
|
||||
|
||||
## Key Files
|
||||
|
||||
| File | Description |
|
||||
|------|-------------|
|
||||
| `benchmark.yml` | 基准测试工作流,运行性能测试并检测回归 |
|
||||
|
||||
## For AI Agents
|
||||
|
||||
### Working In This Directory
|
||||
- 工作流使用 Go 最新稳定版本
|
||||
- 基准测试结果存储用于历史比较
|
||||
- 回归检测失败会阻止 PR 合并
|
||||
|
||||
### Testing Requirements
|
||||
- 工作流自动执行,本地可通过 `make benchmark` 预运行
|
||||
- 回归阈值在 `scripts/check_regression.py` 中定义
|
||||
|
||||
### Common Patterns
|
||||
- 触发条件:`on: push, pull_request`
|
||||
- 步骤:checkout → setup-go → make benchmark → check_regression
|
||||
- 失败处理:输出报告,标记 PR 检查失败
|
||||
|
||||
## Dependencies
|
||||
|
||||
### Internal
|
||||
- `../../Makefile` - 构建命令
|
||||
- `../../scripts/check_regression.py` - 回归检测脚本
|
||||
|
||||
### External
|
||||
- GitHub Actions - 运行环境
|
||||
- Go toolchain - 编译和测试
|
||||
|
||||
<!-- MANUAL: -->
|
||||
Loading…
x
Reference in New Issue
Block a user