feat: Add AGENTS.md and new documents, update README.md
- Introduce AGENTS.md to the root directory. - Add new documents: 小登论道.md and 编程书籍推荐.md to the documents/ directory. - Update README.md (possibly related to directory structure or other changes).
This commit is contained in:
tukuaiai
parent
c0d6f7e3b1
commit
a0caaf803c
|
|
@ -0,0 +1,38 @@
|
|||
# Repository Guidelines
|
||||
|
||||
## Project Structure & Module Organization
|
||||
- 根目录：`README.md` 给出全貌，`Makefile` 封装日常命令，`CONTRIBUTING.md` 说明贡献流程，`LICENSE` 载明协议。保持根目录扁平，避免巨石文件。
|
||||
- 文档库：`documents/` 汇总流程、架构与实践（如 `代码组织.md`、`通用项目架构模板.md`、`开发经验.md`），是理解方法论与协作规则的首选入口。新增流程文档时优先放此处并在 README 链接。
|
||||
- 提示词资产：`prompts/` 按角色拆分（system / assistant / coding / user），`prompts/prompts-library/` 提供 Excel ↔ Markdown 互转工具与脚本目录，便于批量维护提示词，适合作为“单一真实来源”。
|
||||
- 代码与集成：`libs/` 预留核心实现骨架，`common/`、`database/`、`external/` 分别对应通用模型、存储适配与外部依赖登记；新增模块需保持分层边界与单一职责，避免跨层调用。
|
||||
- 备份：`backups/` 内含 `一键备份.sh` 与 `快速备份.py`，用于本地快照或同步，请先在隔离目录试跑，确认输出路径与权限。
|
||||
|
||||
## Build, Test, and Development Commands
|
||||
- `make help`：列出所有 Make 目标，是新人快速上手的入口。
|
||||
- `make lint`：使用 `markdownlint-cli` 校验全仓库 Markdown，一旦新增文档请先跑通（需本地 Node/npm 环境，可用 `npm install -g markdownlint-cli` 安装）。
|
||||
- `make build` / `make test` / `make clean`：目前为占位，落地具体实现后务必更新脚本和说明；建议在 `Makefile` 旁补充注释并保持幂等，避免修改全局状态。
|
||||
- 提示词转换：进入 `prompts/prompts-library/` 后执行 `python main.py` 按交互提示进行转换，运行前请确认虚拟环境、依赖与输出目录，并在完成后检查生成 Markdown 是否符合 lint 规则。
|
||||
|
||||
## Coding Style & Naming Conventions
|
||||
- 文字层：文档、注释、日志使用中文；代码符号（函数 / 变量 / 模块）统一英文且语义直白，避免晦涩缩写。
|
||||
- 缩进与排版：全仓保持空格缩进（2 或 4 空格任选其一但不得混用）；Markdown 列表、代码块与表格对齐清晰，行宽控制在 120 列内。Git diff 可读性优先。
|
||||
- 设计品味：优先消除分支与重复；函数力求单一职责且短小；命名遵循小写加中划线或下划线，不使用空格与特殊字符；跨模块接口保持稳定签名。
|
||||
- 依赖管理：新增工具或库时记录安装方式、最小版本与来源，必要时在 `documents/工具集.md` 或 README 中补充，并说明为何需要它（性能、兼容、功能）。
|
||||
|
||||
## Testing Guidelines
|
||||
- 当前无实测用例；引入代码时请至少提供最小可复现测试。推荐 Python 使用 `pytest`，文件命名 `test_*.py`，夹具精简可读，遵循 red-green-refactor 循环。
|
||||
- 文档与提示词改动：提交前运行 `make lint`；如转换脚本涉及数据，附带示例输入 / 输出说明或最小数据样例，确保可重复。
|
||||
- 覆盖率基线由模块维护者设定；若暂无标准，确保主流程和边界条件均可被测试验证，必要时在 PR 描述中写明未覆盖的风险，并建议后续补测计划。
|
||||
|
||||
## Commit & Pull Request Guidelines
|
||||
- Commit 建议遵循简化 Conventional Commits：`feat|fix|docs|chore|refactor|test: scope – summary`，一句话说明行为与范围；避免笼统的 “update”。
|
||||
- PR 必填：变更摘要、动机或关联 Issue、测试与验证步骤（列出运行的命令与结果概览）；涉及文档 / UI 的修改应附对比截图或链接，方便 reviewer 快速复核。
|
||||
- 提交前清单：跑通 `make lint`；若新增脚本 / 依赖，更新对应文档与 `Makefile` 目标；确认不携带临时文件或机密数据，并在描述中注明潜在风险或需要 reviewer 特别关注的点。
|
||||
|
||||
## Security & Configuration Tips
|
||||
- 运行备份或转换脚本前，确认输出目录不会覆盖私有数据；建议先在临时目录试跑并检查生成文件，必要时使用只读副本。
|
||||
- 外部依赖来源记录在 `libs/external/AGENTS.md`，增减依赖时同步维护，保持可追溯；引入第三方脚本需标明许可证与来源。
|
||||
|
||||
## Architecture Overview & Workflow
|
||||
- 工作流倡导「规划 → 上下文固定 → 分步实现 → 自测 → 复盘」，对应资产分别存放在 `documents/`、`prompts/`、`libs/` 与备份脚本中。保持单向数据流和清晰责任边界可以避免后期维护成本激增。
|
||||
- 设计决策与目录结构更新后，请同步修订本文件与相关文档，确保团队共享同一真相源，减少口头约定与隐式规则。
|
||||
|
|
@ -50,6 +50,7 @@
|
|||
|
||||
- [**vibecoding交流群**](https://t.me/glue_coding)
|
||||
- [**我的频道**](https://t.me/tradecat_ai_channel)
|
||||
- [**小登论道**](./documents/小登论道.md)
|
||||
- [**skill生成器，把任何资料转agent的skill（技能）**](https://github.com/yusufkaraaslan/Skill_Seekers)
|
||||
- [**google表格提示词数据库，我系统性收集和制作的几百个适用于各个场景的用户提示词和系统提示词在线表格**](https://docs.google.com/spreadsheets/d/1ngoQOhJqdguwNAilCl1joNwTje7FWWN9WiI2bo5VhpU/edit?gid=2093180351#gid=2093180351&range=A1)
|
||||
- [**系统提示词收集仓库**](https://github.com/x1xhlol/system-prompts-and-models-of-ai-tools)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,5 @@
|
|||
让我印象最深刻的几段文本
|
||||
|
||||
黄帝阴符经： 绝利一源，用师十倍。三返昼夜，用师万倍
|
||||
|
||||
抖音曰：人者，利之所驱也；大利大为，小利小为，无利不为
|
||||
|
|
@ -0,0 +1,77 @@
|
|||
# z-lib 里面全部都可以免费下载
|
||||
|
||||
从零开始大模型开发与微调：基于PyTorch与ChatGLM - 王晓华
|
||||
编程的原则：改善代码质量的101个方法 - 上田勋
|
||||
生成式 AI 设计模式 - Valliappa Lakshmanan & Hannes Hapke
|
||||
人月神话 - 弗雷德里克·布鲁克斯
|
||||
人件（原书第3版） - Tom DeMarco & Timothy Lister
|
||||
高效程序员的45个习惯：敏捷开发修炼之道 - Andy Hunt & Venkat Subramaniam
|
||||
项目管理修炼之道 - 罗斯曼
|
||||
编程珠玑（续） - 乔恩·本特利
|
||||
编程珠玑（第2版） - 乔恩·本特利
|
||||
编程原则：来自代码大师Max Kanat-Alexander的建议（让简约设计的思想回归到计算机编程，适合软件开发者、开发团队管理者和软件相关专业学生阅读） （华章程序员书库） - Max Kanat-Alexande
|
||||
编写可读代码的艺术 - Dustin Boswell & Trevor Foucher
|
||||
统计思维：程序员数学之概率统计（第2版） - Allen B.Downey
|
||||
精通Rust（第2版） - Rahul Sharma & Vesa Kaihlavirta
|
||||
程序员超强大脑（图灵程序设计丛书·程序员修炼系列） - 费莉安·赫尔曼斯
|
||||
程序员必读之软件架构 - Simon Brown
|
||||
程序员修炼之道：专业程序员必知的33个技巧 - Josh·Carter
|
||||
看漫画学Python：有趣、有料、好玩、好用 - 关东升
|
||||
混沌工程：通过可控故障实验提升软件系统可靠性 - 米科拉吉·帕利科夫斯基_1
|
||||
深入理解Python特性 - 达恩·巴德尔
|
||||
微服务实战（覆盖从微服务设计到部署的各个阶段的技术实战书）（异步图书） - 摩根·布鲁斯 & 保罗·A·佩雷拉
|
||||
大数据系统构建：可扩展实时数据系统构建原理与最佳实践 - NathanMarz & JamesWarren
|
||||
图解性能优化（图灵程序设计丛书） - 小田圭二 & 榑松谷仁 & 平山毅 & 冈田宪昌
|
||||
图灵程序设计丛书：大规模数据处理入门与实战（套装全10册）【图灵出品！一套囊括SQL、Python、Spark、Hadoop、妮哈·纳克海德 & 格温·沙皮拉托德 & 帕利诺 & 本杰明·班福特 & 珍妮·基姆 & 埃伦·弗里德曼 & 科斯塔斯·宙马斯
|
||||
代码整洁之道 - Robert C. Martin
|
||||
代码之髓：编程语言核心概念（图灵程序设计丛书） - 西尾泰和
|
||||
人人都懂设计模式：从生活中领悟设计模式 - 罗伟富
|
||||
Rust权威指南（第2版） - Steve Klabnik & Carol Nichols
|
||||
Python金融大数据分析（第2版） - 伊夫·希尔皮斯科
|
||||
Python科学计算基础教程 - Hemant Kumar Mehta_1
|
||||
Python数据挖掘入门与实践 - Robert Layton
|
||||
Python数据分析与算法指南（套装共8册） - 江雪松 & 邹静 & 邓立国 & 翟锟 & 胡锋 & 周晓然 & 王国平 & 白宁超 & 唐聃 & 文俊 & 张若愚 & 洪锦魁
|
||||
Python性能分析与优化 - Fernando Doglio
|
||||
Python函数式编程（第2版）（图灵图书） - 史蒂文·洛特_1
|
||||
GPT时代的量化交易：底层逻辑与技术实践 - 罗勇 & 卢洪波_1
|
||||
ChatGPT数据分析实践 - 史浩然 & 赵辛 & 吴志成
|
||||
AI时代Python金融大数据分析实战：ChatGPT让金融大数据分析插上翅膀 - 关东升
|
||||
跨市场交易策略 - John J. Murphy
|
||||
资产定价与机器学习 - 吴轲
|
||||
工程思维 - 马克 N. 霍伦斯坦
|
||||
程序员的思维修炼：开发认知潜能的九堂课（图灵程序设计丛书） - Andy Hunt
|
||||
程序员修炼之道：通向务实的最高境界（第2版）【这本书颠覆了无数人的软件生涯！并推动整个IT行业走到今天！时隔20年的再版重磅来袭！】 - 大卫·托马斯 & 安德鲁·亨特
|
||||
不确定状况下的判断：启发式和偏差 - 丹尼尔·卡尼曼
|
||||
简约之美：软件设计之道 - Max Kanant-Alexander
|
||||
程序员的底层思维 - 张建飞
|
||||
程序员的三门课：技术精进、架构修炼、管理探秘 - 于君泽
|
||||
机器学习系统设计（图灵程序设计丛书） - Willi Richert & Luis Pedro Coelho
|
||||
思维工程导论 - 钱小一
|
||||
算法精粹：经典计算机科学问题的Python实现 - David Kopec
|
||||
函数式编程思维 (图灵程序设计丛书) - Neal Ford
|
||||
Python函数式编程（第2版）（图灵图书） - 史蒂文·洛特
|
||||
Effective Python 编写高质量Python代码的90个有效方法（原书第2版） (Effective系列丛书) - Brett Slatkin
|
||||
高频交易（原书第2版） - Irene Aldridge
|
||||
高频交易员：华尔街的速度游戏 - 迈克尔·刘易斯
|
||||
金融学原理（第6版） - 彭兴韵
|
||||
聪明投资者的第一本金融学常识书 - 肖玉红
|
||||
可视化量化金融 - Michael Lovelady
|
||||
GPT时代的量化交易：底层逻辑与技术实践 - 罗勇 & 卢洪波
|
||||
图灵经典计算机基础系列（套装全4册） - 矢泽久雄 & 户根勤 & 平泽章
|
||||
软件开发的201个原则 - Alan M· Davis
|
||||
程序员的AI书：从代码开始 - 张力柯 & 潘晖
|
||||
计算的本质：深入剖析程序和计算机 - Tom Stuart
|
||||
程序员投资指南 - Stefan Papp
|
||||
精通正则表达式（第3版） - Jeffrey E.F.Friedl
|
||||
巧用ChatGPT进行数据分析与挖掘 - 谢佳标
|
||||
工业人工智能三部曲（套装共三册）（世界一流的智能制造专家著作合辑）（2016年被美国制造工程师学会（SME）评选为“美国30位最有远见的智能制造人物”） - 李杰
|
||||
从零构建大模型：算法、训练与微调 - 梁楠
|
||||
Vibe Coding_ Building Production-Grade Software With GenAI, Chat, Agents, and Beyond - Gene Kim & Steve Yegge
|
||||
Vibe Coding AI 编程完全手册 - 谭星星
|
||||
计算机科学概论（第13版） - J. 格伦·布鲁克希尔 & 丹尼斯·布里罗
|
||||
Pro Git （中文版） - Scott Chacon & Ben Straub
|
||||
像程序员一样思考 - V.Anton Spraul
|
||||
Python核心编程（第3版） - Wesley Chun_1
|
||||
AI 工程：从基础模型建构应用 - Chip Huyen
|
||||
AI辅助编程实战 - 汤姆·陶利
|
||||
编码：隐匿在计算机软硬件背后的语言 - Charles Petzold
|
||||
Loading…
Reference in New Issue