📝 文档规范
- 命名规则:使用小写字母与下划线分隔,如
feature_update_v1.0
- 版本控制:所有文档需标注版本号(如
v20231001
)并置于文件名后 - 格式统一:优先使用 Markdown,代码块需明确语言标识(如
// 代码示例
)
🧩 协作流程
- 分支策略:遵循 GitHub Flow 模型
- PR 审核:要求至少 2 名维护者审批,禁止直接合并主分支
- 代码风格:使用 Prettier 自动格式化工具
⚙️ 安全实践
- 依赖管理:定期更新第三方库,使用 Snyk 工具扫描漏洞
- 权限控制:敏感操作需二次验证,禁止直接暴露 API 密钥
- 日志规范:记录错误日志时需脱敏处理(如
user_id: 12345
替代真实数据)