feat: Add CI workflows, issue templates, examples, and prompts

This commit is contained in:
tukuaiai
2025-12-18 17:01:47 +08:00
parent 6427c15ae4
commit ecb6d7f0fa
13 changed files with 252 additions and 1881 deletions
+6 -9
View File
@@ -1,11 +1,8 @@
# .github/ISSUE_TEMPLATE/config.yml
# 配置 Issue 模板选择器
blank_issues_enabled: true
contact_links:
- name: 💬 Telegram 交流群
url: https://t.me/glue_coding
about: 加入我们的 Telegram 群组讨论问题
- name: 📢 Telegram 频道
url: https://t.me/tradecat_ai_channel
about: 关注项目更新和资讯
- name: 📖 在线提示词表格
url: https://docs.google.com/spreadsheets/d/1ngoQOhJqdguwNAilCl1joNwTje7FWWN9WiI2bo5VhpU/edit?gid=2093180351
about: 查看和使用提示词库
- name: 🤔 提问与讨论
url: https://github.com/tukuaiai/vibe-coding-cn/discussions
about: 请使用 GitHub Discussions 进行提问或发起讨论。
+38 -25
View File
@@ -1,29 +1,42 @@
---
name: 文档改进
about: 报告文档问题或建议改进
title: "[Docs]: "
labels: documentation
assignees: ''
name: "📖 文档改进"
description: "提出关于文档的改进建议或报告错误。"
title: "docs: "
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
感谢您花时间来改进我们的文档!
---
- type: textarea
id: problem-description
attributes:
label: "您想改进或报告的问题是什么?"
description: "请清晰、简洁地描述问题。例如:某个链接失效、某个步骤不清晰、某个概念解释有误等。"
validations:
required: true
**文档位置**
请提供需要改进的文档路径或链接。
- type: textarea
id: suggested-solution
attributes:
label: "您的建议方案"
description: "您认为应该如何修正?请提供具体的修改建议。"
validations:
required: true
**问题类型**
- [ ] 内容错误
- [ ] 内容过时
- [ ] 内容缺失
- [ ] 表述不清
- [ ] 链接失效
- [ ] 格式问题
- [ ] 翻译问题
**问题描述**
清晰描述文档存在的问题。
**建议改进**
如果有具体的改进建议,请在此描述。
**附加信息**
任何其他相关信息。
- type: dropdown
id: document-scope
attributes:
label: "涉及的文档范围"
description: "这个问题主要影响哪个部分的文档?"
multiple: true
options:
- "README 主页"
- "Wiki"
- "实战案例"
- "教程与指南"
- "方法论与原则"
- "其他"
validations:
required: true
+44 -33
View File
@@ -1,38 +1,49 @@
---
name: 提示词贡献
about: 分享一个有用的提示词
title: "[Prompt]: "
labels: prompts, contribution
assignees: ''
name: "💡 贡献新的提示词 (Prompt)"
description: "分享一个您认为有价值的编程或 AI 相关的提示词。"
title: "prompt: "
labels: ["prompt", "enhancement"]
body:
- type: markdown
attributes:
value: |
非常感谢您愿意分享您的宝贵提示词!一个好的提示词能极大地提升我们的工作效率。
---
- type: input
id: prompt-name
attributes:
label: "提示词名称"
description: "给您的提示词起一个简洁明了的名称。"
placeholder: "例如:代码调试专家 (Debug Expert)"
validations:
required: true
**提示词名称**
给这个提示词起一个简洁的名字。
- type: textarea
id: prompt-content
attributes:
label: "提示词内容"
description: "请在此处粘贴您的完整提示词内容。请使用 Markdown 代码块进行格式化。"
render: "markdown"
validations:
required: true
**提示词分类**
- [ ] 系统提示词 (system_prompts)
- [ ] 编程提示词 (coding_prompts)
- [ ] 用户提示词 (user_prompts)
- [ ] 辅助提示词 (assistant_prompts)
- [ ] 元提示词 (meta_prompts)
- type: textarea
id: use-case
attributes:
label: "使用场景和说明"
description: "请描述这个提示词主要用于解决什么问题?它的效果如何?如果有任何使用的注意事项,也请一并说明。"
validations:
required: true
**提示词内容**
```
在这里粘贴你的提示词内容
```
**使用场景**
描述这个提示词适用于什么场景。
**效果示例**
如果可能,提供使用这个提示词的效果示例或截图。
**适用模型**
- [ ] Claude
- [ ] GPT
- [ ] Gemini
- [ ] 其他: ___
**附加说明**
任何其他需要说明的内容。
- type: checkboxes
id: checklist
attributes:
label: "确认清单"
description: "在提交前,请确认以下事项。"
options:
- label: "我确认这个提示词是我原创或有权分享的。"
required: true
- label: "我已经在本地测试过这个提示词,并确认其有效性。"
required: true
- label: "我同意将这个提示词以项目所使用的 [MIT License](LICENSE) 授权给社区。"
required: true
+14 -37
View File
@@ -1,45 +1,22 @@
# 文档相关
# .github/labeler.yml
# 为 actions/labeler 定义标签规则
# 文档相关的标签
documentation:
- changed-files:
- any-glob-to-any-file:
- '**/*.md'
- 'docs/**'
- 'i18n/**/documents/**'
- any-glob-to-any-file: ['i18n/**/*.md', 'README.md', 'CONTRIBUTING.md', 'LICENSE']
# 提示词相关
prompts:
# CI/CD 工作流相关的标签
cicd:
- changed-files:
- any-glob-to-any-file:
- 'i18n/**/prompts/**'
- 'libs/external/prompts-library/**'
- any-glob-to-any-file: '.github/workflows/*'
# 技能相关
skills:
# 提示词相关的标签
prompt:
- changed-files:
- any-glob-to-any-file:
- 'i18n/**/skills/**'
- any-glob-to-any-file: 'i18n/zh/prompts/**/*.md'
# 工具相关
tools:
# 实战案例相关的标签
example:
- changed-files:
- any-glob-to-any-file:
- 'libs/**'
- 'backups/**'
# 国际化
i18n:
- changed-files:
- any-glob-to-any-file:
- 'i18n/**'
# CI/CD
ci:
- changed-files:
- any-glob-to-any-file:
- '.github/**'
# 中文内容
chinese:
- changed-files:
- any-glob-to-any-file:
- 'i18n/zh/**'
- any-glob-to-any-file: 'i18n/zh/documents/实战案例/**/*.md'
+20 -46
View File
@@ -1,60 +1,34 @@
# .github/workflows/ci.yml
# 持续集成工作流:用于代码风格检查和链接检查
name: CI
on:
push:
branches: [main, master]
branches: [ main ]
pull_request:
branches: [main, master]
branches: [ main ]
jobs:
lint-markdown:
name: Lint Markdown
markdown-lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Install markdownlint-cli
run: npm install -g markdownlint-cli
- name: Run markdownlint
run: markdownlint '**/*.md' --ignore node_modules --ignore libs/external || true
- name: Checkout code
uses: actions/checkout@v3
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '16'
- name: Install markdownlint-cli
run: npm install -g markdownlint-cli
- name: Run markdownlint
run: markdownlint --config .github/lint_config.json '**/*.md'
check-links:
name: Check Links
link-checker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v3
- name: Link Checker
uses: lycheeverse/lychee-action@v1
uses: lycheeverse/lychee-action@v1.5.0
with:
args: --verbose --no-progress './**/*.md' --exclude-path libs/external
fail: false
validate-structure:
name: Validate Project Structure
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Check required files
run: |
echo "Checking required files..."
files=("README.md" "LICENSE" "CONTRIBUTING.md" "CODE_OF_CONDUCT.md" "AGENTS.md" "CLAUDE.md")
for file in "${files[@]}"; do
if [ -f "$file" ]; then
echo "✓ $file exists"
else
echo "✗ $file missing"
fi
done
- name: Check i18n structure
run: |
echo "Checking i18n directories..."
for lang in zh en; do
if [ -d "i18n/$lang" ]; then
echo "✓ i18n/$lang exists"
else
echo "✗ i18n/$lang missing"
fi
done
args: --verbose --no-progress './**/*.md'
+14 -8
View File
@@ -1,16 +1,22 @@
name: Auto Labeler
# .github/workflows/labeler.yml
# 自动为 Pull Requests 添加标签
on:
pull_request:
types: [opened, synchronize]
name: Labeler
on: [pull_request_target]
permissions:
contents: read
pull-requests: write
jobs:
label:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
- uses: actions/labeler@v5
- name: Checkout code
uses: actions/checkout@v3
- name: Run Labeler
uses: actions/labeler@v4
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
configuration-path: .github/labeler.yml
+16 -28
View File
@@ -1,42 +1,30 @@
name: Welcome New Contributors
# .github/workflows/welcome.yml
# 欢迎新贡献者工作流
name: Welcome First-Timers
on:
pull_request_target:
types: [opened]
issues:
types: [opened]
pull_request:
types: [opened]
permissions:
pull-requests: write
issues: write
jobs:
welcome:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- uses: actions/first-interaction@v1
- name: Welcome new contributor
uses: actions/first-interaction@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
issue-message: |
👋 感谢您提交第一个 Issue
👋 你好,@${{ github.actor }}!感谢你第一次向 vibe-coding-cn 提交 Issue
我们会尽快查看。欢迎你加入我们的社区!
我们非常重视您的反馈。请确保:
- 已阅读 [贡献指南](CONTRIBUTING.md)
- 提供了足够的上下文信息
- 如果是 Bug,请提供复现步骤
我们会尽快回复您!🚀
---
Thanks for opening your first issue! We'll get back to you soon.
pr-message: |
🎉 感谢您提交第一个 Pull Request
这是您对本项目的首次贡献,我们非常感激!请确保:
- PR 描述清晰说明了改动内容
- 代码符合项目规范
- 已更新相关文档(如适用)
我们会尽快审核您的代码!💪
---
Thanks for your first PR! We'll review it soon.
👋 你好,@${{ github.actor }}!感谢你第一次向 vibe-coding-cn 提交 Pull Request
我们将仔细评审你的贡献。感谢你让这个项目变得更好!