Skip to content

Commit 1156793

Browse files
author
hashpanda
committed
chore: 开源最佳实践完善
- 更新 README：修正仓库 URL、添加官网链接、徽章、贡献者墙、Star History - 添加 GitHub 社区文件：CI workflow、Issue/PR 模板、行为准则、安全政策 - 完善 .gitignore：忽略 next-env.d.ts 和 agent lock 文件 - 更新 LICENSE 版权持有人为 funAgent - 移除 PLAN.md 和 TODO.md Made-with: Cursor
1 parent 5721bb4 commit 1156793

14 files changed

Lines changed: 260 additions & 3331 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Bug 反馈
2+
description: 报告课程代码或教学网站中的问题
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
感谢反馈！请尽可能详细地描述问题，以便我们快速定位和修复。
9+
10+
- type: dropdown
11+
id: area
12+
attributes:
13+
label: 问题所在区域
14+
options:
15+
- 课程源码 (agents/)
16+
- 教学文档 (docs/)
17+
- 教学网站 (web/)
18+
- 构建脚本 (scripts/)
19+
- 其他
20+
validations:
21+
required: true
22+
23+
- type: input
24+
id: lesson
25+
attributes:
26+
label: 涉及课程
27+
description: 如果与特定课程有关，请填写课程编号
28+
placeholder: "例如：s06"
29+
30+
- type: textarea
31+
id: description
32+
attributes:
33+
label: 问题描述
34+
description: 清晰地描述遇到的问题
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: reproduce
40+
attributes:
41+
label: 复现步骤
42+
description: 如何复现这个问题？
43+
placeholder: |
44+
1. 进入 agents/s06-configuration 目录
45+
2. 运行 npm install
46+
3. 运行 npx ts-node src/cli.ts
47+
4. 看到错误 ...
48+
49+
- type: textarea
50+
id: expected
51+
attributes:
52+
label: 期望行为
53+
description: 你期望发生什么？
54+
55+
- type: input
56+
id: node-version
57+
attributes:
58+
label: Node.js 版本
59+
placeholder: "例如：20.11.0"
60+
61+
- type: input
62+
id: os
63+
attributes:
64+
label: 操作系统
65+
placeholder: "例如：macOS 15.3 / Ubuntu 24.04 / Windows 11"

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 讨论区
4+
url: https://github.com/funAgent/build-claude-code-cli/discussions
5+
about: 提问、交流学习心得、分享你的实现

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: 功能建议
2+
description: 提出新功能或改进建议
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
感谢你的建议！请描述你希望添加或改进的内容。
9+
10+
- type: dropdown
11+
id: area
12+
attributes:
13+
label: 建议所在区域
14+
options:
15+
- 课程内容（新增课程 / 改进现有课程）
16+
- 教学网站功能
17+
- 开发者体验（工具 / 脚本 / 文档）
18+
- 其他
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: 功能描述
26+
description: 清晰地描述你期望的功能
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: motivation
32+
attributes:
33+
label: 使用场景
34+
description: 为什么需要这个功能？它解决什么问题？
35+
36+
- type: textarea
37+
id: alternatives
38+
attributes:
39+
label: 替代方案
40+
description: 你是否考虑过其他替代方案？

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## 变更说明
2+
3+
<!-- 简要描述这个 PR 做了什么 -->
4+
5+
## 变更类型
6+
7+
- [ ] 课程源码修改 (`agents/`)
8+
- [ ] 教学文档修改 (`docs/`)
9+
- [ ] 教学网站修改 (`web/`)
10+
- [ ] 构建脚本/工具修改 (`scripts/`)
11+
- [ ] 项目配置/文档 (README, CI, etc.)
12+
13+
## 涉及课程
14+
15+
<!-- 如果涉及特定课程，请列出编号，例如：s06, s07, s08 -->
16+
17+
## 自查清单
18+
19+
- [ ] 如果修改了课程源码，已运行 `npm run sync` 同步到后续课程
20+
- [ ] 已运行 `npm run check` 通过一致性校验
21+
- [ ] 已运行 `cd web && npm run build` 确认网站构建成功
22+
- [ ] 教学文档中引用的代码片段与源码一致

‎.github/workflows/ci.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
12+
13+
jobs:
14+
consistency-check:
15+
name: Lesson Consistency
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
- uses: actions/setup-node@v4
20+
with:
21+
node-version: 20
22+
- run: node scripts/check-consistency.mjs
23+
24+
web-build:
25+
name: Web Build
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: actions/checkout@v4
29+
- uses: actions/setup-node@v4
30+
with:
31+
node-version: 20
32+
cache: npm
33+
cache-dependency-path: web/package-lock.json
34+
- run: npm ci
35+
working-directory: web
36+
- run: npm run build
37+
working-directory: web

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,14 @@ node_modules/
44
# Next.js
55
web/.next/
66
web/out/
7+
web/next-env.d.ts
78

89
# Generated (build-time extraction)
910
web/src/data/generated/
1011

12+
# Agent lock files (generated on install)
13+
agents/*/package-lock.json
14+
1115
# Build
1216
dist/
1317
*.tsbuildinfo

‎CODE_OF_CONDUCT.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# 贡献者行为准则
2+
3+
## 我们的承诺
4+
5+
为了营造开放和友好的环境，我们作为贡献者和维护者承诺：参与本项目的每个人都不会受到骚扰，无论其年龄、体型、残疾、种族、性别特征、性别认同和表达、经验水平、教育程度、社会经济地位、国籍、外貌、种族、宗教或性取向。
6+
7+
## 我们的准则
8+
9+
有助于营造积极环境的行为包括：
10+
11+
- 使用友好和包容的语言
12+
- 尊重不同的观点和经验
13+
- 优雅地接受建设性批评
14+
- 关注对社区最有利的事情
15+
- 对其他社区成员表示同情
16+
17+
不可接受的行为包括：
18+
19+
- 使用性暗示的语言或图像，以及不受欢迎的性关注
20+
- 恶意评论、人身攻击或政治攻击
21+
- 公开或私下骚扰
22+
- 未经明确许可发布他人的私人信息
23+
- 其他在专业环境中被合理认为不当的行为
24+
25+
## 我们的责任
26+
27+
项目维护者有责任澄清可接受行为的标准，并对任何不可接受的行为采取适当和公正的纠正措施。
28+
29+
项目维护者有权利和责任删除、编辑或拒绝与本行为准则不一致的评论、提交、代码、wiki 编辑、issue 和其他贡献，并可以暂时或永久地禁止任何他们认为行为不当、具有威胁性、冒犯性或有害的贡献者。
30+
31+
## 适用范围
32+
33+
当个人代表项目或其社区时，本行为准则同时适用于项目空间和公共空间。
34+
35+
## 执行
36+
37+
可以通过 [GitHub Issues](https://github.com/funAgent/build-claude-code-cli/issues) 报告滥用、骚扰或其他不可接受的行为。所有投诉都将被审查和调查，并将产生被认为必要和适当的回应。项目团队有义务对事件报告者保密。
38+
39+
## 归属
40+
41+
本行为准则改编自 [Contributor Covenant](https://www.contributor-covenant.org/) v2.1。

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2026
3+
Copyright (c) 2026 funAgent
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)