Skip to content

Commit 4cc6570

Browse files
pythonHuangclaude
andcommitted
docs: 推广准备工作-README优化+GitHub配置+awesome PR+多平台投稿文案
README 重写: - 新增价值主张口号「积木+魔法」 - 9 个 GitHub 徽章(License/.NET/Vue/ElementPlus/last commit/commit activity/stars/Docker/Build) - 功能特性表格(9 项核心能力) - Mermaid 架构图(FE→API→App→Domain→Infra→DB→AI 服务) - 竞品对比表(Juggle vs n8n vs Dify vs FastGPT/Coze,8 个维度) - 快速开始(Docker + 本地开发) - Star 呼吁收尾 - 英文版本完整对齐 GitHub 仓库配置: - .github/workflows/build.yml — CI 工作流(.NET Build + Frontend Build 双 job) - .github/ISSUE_TEMPLATE/bug_report.md — Bug 报告模板(版本/环境/浏览器/复现步骤/期望/实际) - .github/ISSUE_TEMPLATE/feature_request.md — 功能请求模板(描述/动机/思路/备选/截图) - .github/PULL_REQUEST_TEMPLATE.md — PR 模板(变更类型勾选/描述/相关Issue/截图/自查清单) Awesome 列表 PR 草稿: - docs/awesome-pr.md — 面向 awesome-dotnet(workflow/low-code/net8/vue3/docker) - docs/awesome-ai.md — 面向 awesome-chatgpt/awesome-llm-apps(ai-agent/llm-app/function-calling/rags) 多平台投稿文案: - docs/posts/juejin-article.md — 掘金长文(2000+字,架构解读+技术实现+结语) - docs/posts/csdn-short.md — CSDN 短文章(800字,2分钟上手) - docs/posts/v2ex-post.md — V2EX 分享帖(标题+150字简介) - docs/posts/hn-reddit-post.md — HN/Reddit 英文帖(Show HN 风格) - docs/posts/product-hunt.md — Product Hunt 描述(Slogan+长描述+标签) Co-Authored-By: Claude Code <noreply@anthropic.com>
1 parent e422905 commit 4cc6570

12 files changed

Lines changed: 870 additions & 459 deletions

File tree

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
name: Bug Report
2+
3+
about: 报告 Bug,帮助改进项目
4+
title: '[Bug] '
5+
labels: 'bug'
6+
assignees: ''
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
## 请填写以下信息,帮助我们快速定位问题
13+
14+
- type: input
15+
id: version
16+
attributes:
17+
label: 版本
18+
description: 你使用的是哪个版本?(如 v1.8、v1.7 或未发布版本)
19+
placeholder: v1.8
20+
validations:
21+
required: true
22+
23+
- type: dropdown
24+
id: environment
25+
attributes:
26+
label: 运行环境
27+
description: 你在什么环境下复现了该问题?
28+
multiple: true
29+
options:
30+
- Docker 部署
31+
- Windows 本地运行
32+
- Linux 本地运行
33+
- macOS 本地运行
34+
validations:
35+
required: true
36+
37+
- type: input
38+
id: browser
39+
attributes:
40+
label: 浏览器(如为前端问题)
41+
description: 前端问题请提供浏览器类型及版本
42+
placeholder: Chrome 120 / Edge 120 / Firefox 121
43+
44+
- type: textarea
45+
id: description
46+
attributes:
47+
label: 问题描述
48+
description: 简明扼要地描述你遇到的问题
49+
placeholder: 预期行为是什么,实际遇到了什么问题
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: reproduce
55+
attributes:
56+
label: 复现步骤
57+
description: 请逐步说明如何复现该问题
58+
value: |
59+
1. 进入「XXX」页面
60+
2. 点击「XXX」按钮
61+
3. 在弹窗中输入「XXX」
62+
4. 观察到 XXX 现象
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: expectation
68+
attributes:
69+
label: 期望行为
70+
description: 你期望发生什么?
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: actual
76+
attributes:
77+
label: 实际行为
78+
description: 实际发生了什么?(可包含错误信息、异常堆栈)
79+
validations:
80+
required: true
81+
82+
- type: textarea
83+
id: screenshots
84+
attributes:
85+
label: 截图/录屏
86+
description: 如有,请提供截图或录屏以辅助说明
87+
placeholder: 拖拽图片或粘贴链接
88+
89+
- type: textarea
90+
id: logs
91+
attributes:
92+
label: 日志信息
93+
description: 如有后端日志或浏览器控制台错误,请粘贴在此
94+
render: text
95+
96+
- type: textarea
97+
id: extra
98+
attributes:
99+
label: 补充信息
100+
description: 任何其他相关上下文或备注
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Feature Request
2+
3+
about: 提出新功能或改进建议
4+
title: '[Feature] '
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
## 新功能 / 改进建议
13+
14+
- type: textarea
15+
id: description
16+
attributes:
17+
label: 功能描述
18+
description: 描述你想要的新功能或改进,尽量具体
19+
placeholder: 我希望平台能够支持 XXX...
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: motivation
25+
attributes:
26+
label: 使用动机
27+
description: 为什么需要这个功能?解决了什么痛点?
28+
placeholder: 目前平台缺少 XXX,导致用户无法...
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: implementation
34+
attributes:
35+
label: 实现思路(可选)
36+
description: 如果你有初步的实现方案或思路,请在此分享
37+
placeholder: 建议在 XXX 模块增加 YYY 功能...
38+
39+
- type: textarea
40+
id: alternatives
41+
attributes:
42+
label: 备选方案
43+
description: 你是否考虑过其他实现方式?它们各自的优缺点是什么?
44+
45+
- type: textarea
46+
id: screenshots
47+
attributes:
48+
label: 参考截图/设计稿(可选)
49+
description: 如有参考实现或设计稿,请在此附上
50+
placeholder: 拖拽图片或粘贴链接
51+
52+
- type: textarea
53+
id: extra
54+
attributes:
55+
label: 补充信息
56+
description: 任何其他相关上下文或备注

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Pull Request Template
2+
3+
about: ''
4+
pull_request:
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## 变更类型
10+
请勾选适用的类型:
11+
12+
- type: checkboxes
13+
id: type
14+
attributes:
15+
label: 变更类型
16+
options:
17+
- label: 'feat — 新功能'
18+
- label: 'fix — Bug 修复'
19+
- label: 'refactor — 代码重构(无功能变化)'
20+
- label: 'docs — 文档更新'
21+
- label: 'style — 代码格式调整(不影响逻辑)'
22+
- label: 'perf — 性能优化'
23+
- label: 'test — 测试相关'
24+
- label: 'chore — 构建/CI/工具链调整'
25+
26+
- type: textarea
27+
id: description
28+
attributes:
29+
label: 变更描述
30+
description: 简明扼要地描述本次变更的内容
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: related-issue
36+
attributes:
37+
label: 相关 Issue
38+
description: 如有,请填写相关 Issue 编号(如 #123)
39+
placeholder: 'Fixes #'
40+
41+
- type: textarea
42+
id: screenshots
43+
attributes:
44+
label: 截图(如适用)
45+
description: 前端变更请附带截图或 GIF
46+
placeholder: 拖拽图片或粘贴链接
47+
48+
- type: textarea
49+
id: checklist
50+
attributes:
51+
label: 自查清单
52+
description: 提交前请确认以下事项
53+
value: |
54+
- [ ] 代码已通过本地构建/测试
55+
- [ ] 已更新相关文档(如适用)
56+
- [ ] 遵循了项目的编码规范

‎.github/workflows/build.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Build and Test
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
backend-build:
11+
name: .NET Build
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v4
16+
17+
- name: Setup .NET 8
18+
uses: actions/setup-dotnet@v4
19+
with:
20+
dotnet-version: '8.0.x'
21+
22+
- name: Restore dependencies
23+
run: dotnet restore Juggle.sln
24+
25+
- name: Build
26+
run: dotnet build Juggle.sln --verbosity quiet --no-restore
27+
28+
- name: Test
29+
run: dotnet test Juggle.sln --verbosity quiet --no-build --nologo
30+
31+
frontend-build:
32+
name: Frontend Build
33+
runs-on: ubuntu-latest
34+
steps:
35+
- name: Checkout code
36+
uses: actions/checkout@v4
37+
38+
- name: Setup Node.js
39+
uses: actions/setup-node@v4
40+
with:
41+
node-version: '20'
42+
cache: 'npm'
43+
cache-dependency-path: JuggleNet6.Frontend/package-lock.json
44+
45+
- name: Install dependencies
46+
run: cd JuggleNet6.Frontend && npm ci
47+
48+
- name: Build
49+
run: cd JuggleNet6.Frontend && npm run build

0 commit comments

Comments
 (0)