mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-07-28 03:07:56 +00:00
chore: governance - tighten repo hygiene
This commit is contained in:
@@ -0,0 +1,16 @@
|
||||
# .github/ Agent 指南
|
||||
|
||||
本目录承载 GitHub 平台自动化与协作配置。
|
||||
|
||||
## 约束
|
||||
|
||||
- 修改 `workflows/` 前必须确认对应本地命令或验证方式。
|
||||
- 修改 Issue / PR 模板时保持字段简洁、可执行、可审查。
|
||||
- 修改安全政策时同步公开联系邮箱口径。
|
||||
- 不提交任何密钥、Token、cookie、私有证书或本地账号信息。
|
||||
|
||||
## 验证
|
||||
|
||||
```bash
|
||||
make test
|
||||
```
|
||||
@@ -0,0 +1,9 @@
|
||||
# .github/ISSUE_TEMPLATE/ Agent 指南
|
||||
|
||||
本目录维护 GitHub Issue 模板。
|
||||
|
||||
## 约束
|
||||
|
||||
- 字段保持简洁,优先收集问题、期望结果、复现路径和相关链接。
|
||||
- 不加入无意义的长免责声明。
|
||||
- 不要求用户公开敏感信息。
|
||||
@@ -0,0 +1,9 @@
|
||||
# .github/ISSUE_TEMPLATE
|
||||
|
||||
Issue 模板目录,用于统一反馈、纠错、资料补充和问题报告格式。
|
||||
|
||||
## 维护规则
|
||||
|
||||
- 模板字段必须服务于复现、定位和归类。
|
||||
- 不要求用户提交隐私信息、密钥或账号凭证。
|
||||
- 模板变更后检查 Markdown 格式。
|
||||
@@ -0,0 +1,19 @@
|
||||
# .github
|
||||
|
||||
GitHub 平台配置目录,集中管理 CI、Issue 模板、PR 模板、安全政策、赞助配置和 Wiki 说明。
|
||||
|
||||
## 目录
|
||||
|
||||
- `workflows/` - GitHub Actions 工作流。
|
||||
- `ISSUE_TEMPLATE/` - Issue 表单和模板。
|
||||
- `PULL_REQUEST_TEMPLATE.md` - PR 描述模板。
|
||||
- `SECURITY.md` - 安全报告入口。
|
||||
- `WIKI.md` - Wiki 使用说明。
|
||||
- `labeler.yml` - PR 自动标签规则。
|
||||
- `lint_config.json` - Markdown lint 配置。
|
||||
|
||||
## 维护规则
|
||||
|
||||
- CI 变更必须能用本地命令复现核心检查。
|
||||
- 外链检查规则集中放在 `.lychee.toml`。
|
||||
- 不在此目录保存密钥、Token 或本地账号信息。
|
||||
@@ -0,0 +1,10 @@
|
||||
# .github/workflows/ Agent 指南
|
||||
|
||||
本目录只放 GitHub Actions 工作流。
|
||||
|
||||
## 约束
|
||||
|
||||
- 不新增无法在本地解释的黑盒步骤。
|
||||
- 不在 workflow 中写入密钥明文。
|
||||
- 修改 CI 后必须运行 `make test`,并在推送后查看 GitHub Actions 结果。
|
||||
- 外链检查配置优先修改仓库根目录 `.lychee.toml`,不要在 workflow 里堆长排除列表。
|
||||
@@ -0,0 +1,13 @@
|
||||
# .github/workflows
|
||||
|
||||
GitHub Actions 工作流目录。
|
||||
|
||||
## 当前工作流
|
||||
|
||||
- `ci.yml` - Markdown lint、本地链接、docs 结构、目录治理、metadata、AI citation 和外链检查。
|
||||
|
||||
## 维护规则
|
||||
|
||||
- 优先复用 `Makefile` 和 `scripts/` 中已有门禁。
|
||||
- 外链检查排除规则放在 `.lychee.toml`。
|
||||
- action 版本升级后必须观察远端 CI 结果。
|
||||
@@ -46,22 +46,4 @@ jobs:
|
||||
- name: Link Checker
|
||||
uses: lycheeverse/lychee-action@v2.8.0
|
||||
with:
|
||||
args: >-
|
||||
--verbose
|
||||
--no-progress
|
||||
--exclude-path .history
|
||||
--exclude-path .github/wiki
|
||||
--exclude-path node_modules
|
||||
--exclude-path tools/external
|
||||
--exclude-path tools/chat-vault
|
||||
--exclude-path tools/prompts-library
|
||||
--exclude-path skills/claude-official-skills
|
||||
--exclude-path skills/auto-skill/scripts/Skill_Seekers-development
|
||||
--exclude-path skills/auto-skill/scripts/skill-seekers-src
|
||||
--exclude-path skills/auto-skill/scripts/skill-seekers-configs
|
||||
--exclude 'https://chatgpt.com.*'
|
||||
--exclude 'https://claude.ai.*'
|
||||
--exclude 'https://app.augmentcode.com.*'
|
||||
--exclude 'https://platform.openai.com.*'
|
||||
--exclude 'https://user-images.githubusercontent.com.*'
|
||||
'./**/*.md'
|
||||
args: --verbose --no-progress --config .lychee.toml './**/*.md'
|
||||
|
||||
Reference in New Issue
Block a user