欢迎访问 项目风格指南，本指南旨在为开发者提供统一的编码规范与协作标准，确保代码质量和项目可持续性。

1. 代码规范 🧰

  • 缩进：使用 4 个空格或 Tab 键，保持团队一致性
  • 命名：变量名用 snake_case，函数名用 camelCase（参考 项目架构设计）
  • 注释：关键逻辑需添加中文注释，注释与代码保持同步更新
  • 格式：遵循 Prettier 自动格式化规则，禁用 eslint-disable 除外情况

2. 文档结构 📁

  • 主文档需包含：项目简介、安装指南、API 说明、示例代码
  • 使用 Markdown 标题分级（#、##、###）组织内容
  • 代码块添加语言标识，如 javascript 或 python
  • 图片命名规范：project_overview、folder_structure 等（示例：
    项目架构
    ）

3. 提交规范 📝

  • 提交信息遵循 Conventional Commits 标准
  • feat: 新增功能
  • fix: 修复 bug
  • docs: 文档更新
  • style: 代码格式调整
  • refactor: 代码重构
  • perf: 性能优化

4. 扩展阅读 🔍

5. 贡献指南 ✨

新贡献者请先阅读 贡献规范，了解代码审查流程与测试要求。

贡献流程

📌 本指南将持续更新，建议定期查看 最新版本 以获取规范变动提醒。