From 45b9d3b8eb41f335c180c9a26c7f8b51054e81cc Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 13 Dec 2025 09:52:56 +0800 Subject: [PATCH] feat: Add GitHub community files and update contact information MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit introduces standard GitHub community files including: - Issue templates for bug reports and feature requests. - Pull Request template. - Security policy with contact email. - Funding configuration with GitHub Sponsors and custom links. Updates include: - .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md. - .github/PULL_REQUEST_TEMPLATE.md. - .github/SECURITY.md with tukuai.ai@gmail.com as contact email. - .github/FUNDING.yml with github: tukuaiai and custom crypto/social links. - README.md with a new 联系方式 section and fixed Mermaid diagram syntax. - .gitignore updated to track .github/ directory. This ensures better community engagement and project maintainability. --- .github/FUNDING.yml | 25 ++++++ .github/ISSUE_TEMPLATE/bug_report.md | 41 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++ .github/PULL_REQUEST_TEMPLATE.md | 37 +++++++++ .github/SECURITY.md | 26 ++++++ .gitignore | 1 - README.md | 97 ++++++++++++++++++++--- 7 files changed, 233 insertions(+), 14 deletions(-) create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/SECURITY.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..f345fff --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,25 @@ +# GitHub 赞助配置文件 +# 这些链接将显示在 GitHub 仓库主页的“赞助”按钮旁边。 + +github: tukuaiai # 您的 GitHub 用户名，例如: [octocat] +# patreon: your-patreon-username # 您的 Patreon 用户名 +# open_collective: your-opencollective-project-name # 您的 Open Collective 项目名称 +# ko_fi: your-ko-fi-username # 您的 Ko-fi 用户名 +# tidelift: # Tidelift 支持 +# - package-name/platform +# - another-package/platform +# community_bridge: your-community-bridge-project-name # 您的 Community Bridge 项目名称 +# liberapay: your-liberapay-username # 您的 Liberapay 用户名 +# issuehunt: your-issuehunt-username # 您的 IssueHunt 用户名 +# otechie: your-otechie-username # 您的 Otechie 用户名 +custom: + - 'https://t.me/desci0' + - 'tron: TQtBXCSTwLFHjBqTS4rNUp7ufiGx51BRey' + - 'sol: HjYhozVf9AQmfv7yv79xSNs6uaEU5oUk2USasYQfUYau' + - 'eth: 0xa396923a71ee7D9480b346a17dDeEb2c0C287BBC' + - 'bsc: 0xa396923a71ee7D9480b346a17dDeEb2c0C287BBC' + - 'btc: bc1plslluj3zq3snpnnczplu7ywf37h89dyudqua04pz4txwh8z5z5vsre7nlm' + - 'sui: 0xb720c98a48c77f2d49d375932b2867e793029e6337f1562522640e4f84203d2e' + - 'telegram: desci0' + - 'x(twitter): https://x.com/123olp' + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..faf924f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,41 @@ +--- +name: Bug 报告 +about: 报告一个 Bug 以帮助我们改进 +title: "[Bug]: " +labels: bug +assignees: '' + +--- + +**描述您遇到的 Bug** +清晰简洁地描述问题所在。 + +**重现步骤** +重现行为的步骤： +1. 前往 '...' +2. 点击 '....' +3. 滚动到 '....' +4. 查看错误 + +**预期行为** +清晰简洁地描述您期望发生的事情。 + +**实际行为** +清晰简洁地描述实际发生的事情。 + +**截图** +如果适用，添加截图以帮助解释您的问题。 + +**桌面环境 (请填写以下信息):** +- 操作系统: [例如 iOS, Android, Windows, Mac, Linux] +- 浏览器: [例如 chrome, safari] +- 版本: [例如 22] + +**智能手机环境 (请填写以下信息):** +- 设备: [例如 iPhone6] +- 操作系统: [例如 iOS8.1] +- 浏览器: [例如 safari] +- 版本: [例如 22] + +**附加信息** +您在此处可以添加任何其他上下文信息。 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..2aca3e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: 功能请求 +about: 提出一个新功能或改进现有功能 +title: "[Feature]: " +labels: enhancement +assignees: '' + +--- + +**您希望解决什么问题？** +清晰简洁地描述您希望通过此功能解决的问题。 + +**您希望实现什么解决方案？** +清晰简洁地描述您希望实现的解决方案。 + +**考虑过的替代方案** +清晰简洁地描述您已经考虑过的任何替代解决方案或功能。 + +**附加信息** +您在此处可以添加任何其他上下文信息或截图。 diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..eac6529 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,37 @@ +--- +name: Pull Request +about: 提交您的贡献 +title: "[类型]: 描述" +labels: '' +assignees: '' + +--- + +**请描述本次 PR 的类型** +例如： +- [ ] Bug 修复 +- [ ] 功能增加 +- [ ] 代码优化/重构 +- [ ] 文档更新 +- [ ] 其他 (请说明): + +**本次 PR 解决了什么问题或增加了什么功能？** +请清晰简洁地描述本次 Pull Request 的目的和具体改动。 + +**相关 Issue** +请关联本次 PR 解决或关联的 Issue (例如：`Closes #123`, `Fixes #456`, `Related to #789`)。 + +**测试步骤** +请描述如何测试本次改动。例如： +1. `git checkout ` +2. `npm install` (如果依赖有变动) +3. `npm test` 或 `yarn test` +4. 运行应用并验证 `...` + +**检查列表** +请在提交 PR 前确保以下事项已完成： +- [ ] 我已阅读并遵循项目的贡献指南。 +- [ ] 我已在本地运行了测试，并且所有测试都通过了。 +- [ ] 我已确保代码风格与项目保持一致。 +- [ ] 我已更新了相应的文档 (如果适用)。 +- [ ] 我已对本次提交进行了有意义的 Commit Message。 diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..ca7e76d --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,26 @@ +# 安全策略 + +我们非常重视 `vibe-coding-cn` 项目的安全。本文件概述了如何向我们报告安全漏洞，以及我们将如何处理这些漏洞。 + +## 报告漏洞 + +我们恳请您通过电子邮件向我们报告任何潜在的安全漏洞，而不是在公共 Issue 跟踪器中披露。这将使我们有机会在漏洞被公开利用之前进行修复。 + +请将详细信息发送至：tukuai.ai@gmail.com + +请在报告中包含以下信息： +* 漏洞的详细描述。 +* 重现漏洞的步骤。 +* 受影响的版本。 +* 如果可能，提供概念验证 (PoC) 或利用代码。 + +## 我们的承诺 + +一旦收到您的安全报告，我们将： +* 在合理的时间内确认收到您的报告。 +* 调查漏洞并确定其影响。 +* 与您协作解决漏洞。 +* 在修复完成后通知您。 +* 在适当的时候公开致谢您的贡献 (如果您同意)。 + +我们致力于尽快解决所有报告的安全问题，并感谢您帮助我们确保 `vibe-coding-cn` 项目的安全。 diff --git a/.gitignore b/.gitignore index 542e41a..b519eed 100644 --- a/.gitignore +++ b/.gitignore @@ -42,7 +42,6 @@ venv.bak/ # IDE .vscode/ .idea/ -.github/ *.swp *.swo *~ diff --git a/README.md b/README.md index 763fc8a..1288c14 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,15 @@ --- +## ✉️ 联系方式 + +- **GitHub**: [tukuaiai](https://github.com/tukuaiai) +- **Telegram**: [@desci0](https://t.me/desci0) +- **X (Twitter)**: [@123olp](https://x.com/123olp) +- **Email**: `tukuai.ai@gmail.com` + +--- + ### 项目目录结构概览 本项目 `vibe-coding-cn` 的核心结构主要围绕知识管理、AI 提示词的组织与自动化展开。以下是经过整理和简化的目录树及各部分说明： @@ -177,17 +186,81 @@ backups/ ``` ```mermaid -graph TD - Need[输入: 需求] --> CP[(coding_prompts 需求澄清/计划化)] - CP --> Context[documents/* 上下文文档\nproject-context.md] - Context --> SP[(system_prompts 行为约束)] - SP --> Exec[执行: AI 结对编程 + 人类审阅] - Exec --> Test[自测: 计划内验证 / make test] - Test --> Progress[progress.md & README 更新] - Progress --> Backup1[backups/一键备份.sh] - Progress --> Backup2[backups/快速备份.py] - prompts-library -->|生成/维护| CP - documents -->|知识基线| Exec +graph TB + %% 语义样式 + classDef dataFlow stroke:#1565c0,stroke-width:2px; + classDef control stroke-dasharray: 3 3,stroke:#8e24aa,stroke-width:1.6px; + classDef async stroke-dasharray: 2 4,stroke:#2e7d32,stroke-width:1.6px; + + subgraph 🌍 外部系统与数据源层 + ext_contrib[社区贡献者] + ext_sheet[Google表格 / 外部表格数据] + ext_md[外部 Markdown 提示词] + ext_api[未来可扩展数据源 / API] + ext_contrib --> ext_sheet + ext_contrib --> ext_md + ext_api -.-> ext_sheet + end + + subgraph 🔍 数据接入与采集层 + excel_raw[prompt_excel/*.xlsx 原始表] + md_raw[prompt_docs/外部MD输入] + excel_to_docs[prompts-library/scripts/excel_to_docs.py] + docs_to_excel[prompts-library/scripts/docs_to_excel.py] + ingest_bus[标准化数据帧] + ext_sheet --> excel_raw + ext_md --> md_raw + excel_raw --> excel_to_docs + md_raw --> docs_to_excel + excel_to_docs --> ingest_bus + docs_to_excel --> ingest_bus + end + + subgraph ⚙️ 数据处理与智能决策层（核心） + validate[字段校验与规范化] --> transform[格式映射转换引擎] + transform --> artifacts_md[生成 prompt_docs/规范MD] + transform --> artifacts_xlsx[生成 prompt_excel/导出XLSX] + orchestrator[main.py · scripts/start_convert.py 调度] -.-> validate + orchestrator -.-> transform + ingest_bus --> validate + end + + subgraph 📥 执行与消费层 + artifacts_md --> catalog_coding[prompts/coding_prompts 编程链路提示词] + artifacts_md --> catalog_system[prompts/system_prompts 行为约束提示词] + artifacts_md --> catalog_assist[prompts/assistant_prompts 辅助提示词] + artifacts_md --> catalog_user[prompts/user_prompts 用户提示词] + artifacts_md --> docs_repo[documents/* 知识库引用] + artifacts_md -.-> new_consumer[其他下游/发布渠道] + catalog_coding --> ai_flow[AI 结对编程流程] + ai_flow --> deliverables[项目上下文 / 计划 / 代码产出] + end + + subgraph 👥 用户交互与接口层 + cli[CLI: python main.py] --> orchestrator + makefile[Makefile 任务封装] -.-> cli + readme[README.md 使用指南] -.-> cli + end + + subgraph 🧱 基础设施与横切能力层 + git[Git 版本控制] -.-> orchestrator + backups[backups/一键备份.sh · backups/快速备份.py] -.-> artifacts_md + deps[requirements.txt · scripts/requirements.txt 依赖] -.-> orchestrator + config[prompts-library/scripts/config.yaml 配置] -.-> orchestrator + monitor[日志/监控（外部接入预留）] -.-> orchestrator + end + + %% 横切覆盖示意 + backups -.-> catalog_coding + git -.-> validate + config -.-> validate + + %% Legend + subgraph Legend[Legend] + legend_data[实线箭头：主数据流] + legend_ctrl[虚线：控制/配置/调度] + legend_async[点虚线：外部/异步接口] + end ``` --- @@ -452,5 +525,3 @@ gantt **Made with ❤️ and a lot of ☕ by [tukuaiai](https://github.com/tukuaiai),[Nicolas Zullo](https://x.com/NicolasZu)and [123olp](https://x.com/123olp)** [⬆ 回到顶部](#vibe-coding-终极指南-v12) - -