欢迎阅读 社区开发规范,以下是为保障项目质量与协作效率的重要规则:
📝 编写规范
- 代码风格:请遵循 代码规范 统一格式,使用空格代替Tab,每行不超过80字符
- 注释要求:核心逻辑需添加注释,使用
//
或/* */
格式,禁止出现敏感内容 💡 - 命名规范:变量名使用小驼峰(
myVariable
),文件名用全小写(utils.js
)
⚙️ 协作流程
- 分支管理:主分支为
develop
,功能开发分支需以feature/
开头 - 代码审查:提交PR前请通过 CI/CD流程 自动测试,等待团队评审 🤝
- 合并策略:采用squash合并,保留提交历史清晰性
🔄 版本控制
- 标签规范:发布版本需添加
vX.X.X
标签,如v1.0.0
- 变更记录:更新日志需包含功能改进、Bug修复和安全更新 🔒
- 依赖管理:使用
package-lock.json
固定依赖版本,避免冲突
⚠️ 安全实践
- 禁止直接暴露敏感信息(如API密钥)
- 所有接口需通过 安全测试 验证
- 定期清理无用依赖,降低攻击面
如需进一步了解,请访问 社区常见问题 获取详细说明 📚