49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
|
# n8n 项目开发规范
|
|||
|
|
|
|||
|
|
## 项目路径
|
|||
|
|
- 项目根目录: /Users/xiaoqi/Documents/Dev/Project/2025-09-08_n8nDEMO演示
|
|||
|
|
- n8n源码目录: n8n-n8n-1.109.2/
|
|||
|
|
|
|||
|
|
## 运行方式偏好
|
|||
|
|
- **首选**: 使用 `pnpm dev` 开发模式运行（支持热更新）
|
|||
|
|
- 备选: `pnpm build` 后使用 `pnpm start` 运行
|
|||
|
|
- 不使用 `npx n8n`（会下载最新版本而非本地代码）
|
|||
|
|
|
|||
|
|
## Git 提交规范（必须严格执行）
|
|||
|
|
|
|||
|
|
### 分支管理
|
|||
|
|
- 工作分支: `My_N8N`
|
|||
|
|
- 每次任务完成后必须自动提交到此分支
|
|||
|
|
|
|||
|
|
### 提交信息格式
|
|||
|
|
```
|
|||
|
|
[任务类型]: 任务描述（50字符以内）
|
|||
|
|
|
|||
|
|
详细说明:
|
|||
|
|
- 完成的具体工作内容
|
|||
|
|
- 修改的文件列表
|
|||
|
|
- 影响的功能模块
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 任务类型
|
|||
|
|
- feat: 新功能
|
|||
|
|
- fix: 修复
|
|||
|
|
- docs: 文档
|
|||
|
|
- style: 格式
|
|||
|
|
- refactor: 重构
|
|||
|
|
- test: 测试
|
|||
|
|
- chore: 杂项
|
|||
|
|
|
|||
|
|
### 自动提交流程
|
|||
|
|
1. 切换到项目根目录
|
|||
|
|
2. 确保在 My_N8N 分支
|
|||
|
|
3. git add .
|
|||
|
|
4. git commit -m "规范化的提交信息"
|
|||
|
|
5. 查看提交历史确认
|
|||
|
|
|
|||
|
|
## 开发注意事项
|
|||
|
|
1. 始终使用 pnpm 而不是 npm 或 yarn
|
|||
|
|
2. 在 n8n-n8n-1.109.2 目录下执行命令
|
|||
|
|
3. 运行测试前先进入对应的包目录
|
|||
|
|
4. 提交代码前运行 lint 和 typecheck
|
|||
|
|
5. 构建命令输出重定向到日志文件以便查看错误
|