添加项目配置文件和调整 gitignore
- 新增 AGENTS.md(项目指令集) - 新增 CLAUDE.md(代码库文档) - 更新 .gitattributes 和 .gitignore - 新增 .claude/ 目录
This commit is contained in:
31
AGENTS.md
Normal file
31
AGENTS.md
Normal file
@@ -0,0 +1,31 @@
|
||||
## 项目结构
|
||||
|
||||
```bash
|
||||
根目录
|
||||
├── contents/ # 资源型文件
|
||||
├── notes/ # 笔记、白板
|
||||
├── references/
|
||||
│ ├── client/ # 客户给的资料
|
||||
│ ├── papers/ # 文献资料
|
||||
│ └── visuals/ # 视觉参考
|
||||
├── subspaces/ # 工程文件、创作文件
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Markdown 规范
|
||||
- 中文为主(专有名词、约定俗称可以用英文)
|
||||
- 不使用`---`分割器
|
||||
- `# Heading` 一级标题仅用于开头
|
||||
|
||||
## 代码规范
|
||||
|
||||
- 避免嵌套结构
|
||||
- 特殊的、非常规的需要写注释
|
||||
- 提交说明、文档用中文为主(专有名词、约定俗称可以用英文)
|
||||
- 注释用中文为主(专有名词、约定俗称可以用英文)
|
||||
- 变量、函数名、Docstring 用全英文
|
||||
- 同一事物用统一表达
|
||||
- 使用的依赖越少越好
|
||||
- 选用简单直接的方式实现
|
||||
- 代码、执行方式改变,调整已有的文档、计划,而非新建
|
||||
Reference in New Issue
Block a user