代码贡献规范指南 📜
欢迎阅读我们的代码贡献规范！遵循这些指南将帮助您更高效地参与项目开发，同时保持代码质量与一致性。🔧
🧩 命名规范
- 变量名：使用小写字母和下划线，如
user_name - 函数名：采用动词开头，如
calculate_total() - 文件名：用小写字母和短横线，如
data_utils.js - 类名：使用大写驼峰式，如
ConfigManager
📦 代码风格
- 保持4个空格缩进（禁用Tab）
- 每行不超过80字符
- 使用空格分隔运算符（如
x = 5 + 3） - 引入代码时需注明来源，例如 查看贡献流程
📝 注释规范
- 函数注释需包含参数说明与返回值
- 复杂逻辑需添加行内注释（以
//开头） - 避免重复说明显而易见的代码
⚠️ 错误处理
- 所有异常需捕获并记录日志
- 使用
try/catch块包裹关键逻辑 - 错误码需统一使用数字格式（如
ERROR_404）
📌 版本控制
- 提交代码前确保通过单元测试
- 使用语义化版本号（如
v1.2.3） - 提交信息需清晰描述更改内容