欢迎阅读我们的贡献标准文档!以下是为确保高质量协作制定的核心规范:
1. 代码规范 🧩
- 命名规则:使用英文命名,类名首字母大写(如
UserProfile
),变量名小写(如user_name
) - 格式要求:遵循 PEP8 编码规范,缩进使用4个空格
- 注释标准:关键逻辑需添加中文注释(如
// 初始化用户数据
)
2. 文档规范 📝
- 语言统一:技术文档使用中文,API说明可保留英文术语
- 结构清晰:采用 Markdown 格式,包含目录、章节编号
- 示例要求:代码示例需标注语言类型(如
python
或javascript
)
3. 贡献流程 🧭
- 阅读 贡献指南 确认流程
- 创建Issue讨论需求
- 分支开发并提交PR
- 通过Code Review后合并
遵循这些标准,让我们共同维护项目的质量!🚀