代码规范

  • 命名规则:变量名使用英文小写,单词间用下划线连接,如 user_info
    代码规范
  • 格式化:遵循 Prettier 或 ESLint 规则,保持缩进一致(建议 2 空格)。
  • 注释:关键逻辑需添加注释,注释语言与代码一致。

文档编写

  • 使用 Markdown 格式,标题层级清晰(# 为一级标题,## 为二级)。
  • 代码示例需用反引号包裹,并标注语言类型(如 javascript)。
  • 链接规范:文档内引用其他资源时,使用本站路径如 /Documentation/zh/Developer/Community/GitHub/Contributing

提交信息

  • 标题简明,动词使用现在分词形式(如 fix: resolve bug in login flow)。
  • 正文说明更改内容及原因,不超过 50 字。

扩展阅读

如需了解更详细的贡献规范,请参考:
GitHub 贡献指南

GitHub 风格指南