fe59c8b49987dc9f68ee7c572ac1fe818f23f70b
- 安装 husky 和 lint-staged 用于 Git hooks 管理 - 配置 pre-commit 检查:ESLint、TypeScript、Prettier - 添加 Prettier 代码格式化配置和插件 - 更新项目文档说明 pre-commit 工作流程 - 配置文件包括: - .husky/pre-commit: Git pre-commit hook 脚本 - lint-staged.config.js: lint-staged 配置 - frontend/.prettierrc: Prettier 配置 - frontend/.prettierignore: Prettier 忽略文件 现在每次提交前会自动运行代码检查和格式化
产品文档
本目录包含摄影作品集项目的完整产品文档。
文档结构
📐 Design(设计文档)
- UI/UX 设计规范
- 组件设计系统
- 交互设计文档
- 品牌指南和视觉规范
🔌 API(API 文档)
- API 接口文档
- 数据结构定义
- 接口调用示例
- 错误码说明
👥 User Guide(用户指南)
- 用户操作手册
- 功能使用说明
- 常见问题解答
- 最佳实践指南
🛠️ Development(开发文档)
- 开发环境搭建
- 代码规范和约定
- 开发工作流程
- 测试指南
🚀 Deployment(部署文档)
- 部署配置说明
- 环境变量配置
- 服务器配置要求
- 部署流程和脚本
文档维护
请在相应的子目录中维护各类文档,确保文档的及时更新和准确性。
贡献指南
- 在相应目录下创建或更新文档
- 使用 Markdown 格式编写
- 确保文档结构清晰、内容准确
- 添加适当的图片和示例代码
Description
Languages
TypeScript
62.2%
Go
19.5%
Shell
12.5%
Makefile
2.2%
PLpgSQL
1.6%
Other
2%