欢迎访问代码贡献指南!请遵守以下规范确保代码质量:

📌 编码规范

  • 语言一致性:所有提交代码需与项目主语言保持一致(当前为TypeScript)
  • 格式标准:使用EditorConfig统一代码格式
  • 注释要求:关键逻辑需添加中文注释(<!-- -->格式)

📜 命名规范

类型 示例 说明
变量 user_id 小驼峰命名法
函数 fetchData() 动词+名词结构
常量 MAX_RETRY_COUNT 大驼峰命名法

🧹 代码风格

  • 缩进:2个空格
  • 行宽:80字符以内
  • 引号:使用双引号 "
  • 代码块:```ts 语法高亮
// 示例代码
function greet(name: string): string {
  return `Hello, ${name}!`;
}

📖 文档编写

  1. 使用Markdown格式
  2. 配合文档模板
  3. 添加示例时需包含Emoji说明 📌

📤 提交指南

  • 提交信息遵循Conventional Commits
  • 功能新增使用 feat: 前缀
  • 修复问题使用 fix: 前缀
  • 文档更新使用 docs: 前缀
代码规范

如需了解更多,请查看贡献指南首页