🎉 欢迎贡献代码到 TensorFlow 项目!以下为代码风格指南 📚

代码风格规范

为确保代码一致性,请遵循以下原则:

  • 命名规范
    📌 变量名使用 snake_case,函数名使用 camelCase
    📌 类名首字母大写,如 TensorFlowModel

    命名规范示例

  • 格式要求
    📌 使用 4 空格缩进,遵循 PEP8
    📌 每行不超过 79 个字符,长代码用 """ 包裹

    格式检查工具

  • 文档注释
    📌 必须包含 docstring,使用 Google 风格
    📌 示例:

    def example_function():
        """描述函数功能 ✅
        Args:
            param1: 描述参数
        Returns:
            返回值说明
        """
    

    文档注释模板

🔗 需要查看完整文档规范?请前往 /tensorflow_docs/contribute/overview 扩展阅读 🚀

贡献流程

  1. 📌 Fork 项目仓库
  2. 📌 创建功能分支 feature/your_name
  3. 📌 编写代码并遵循风格指南 📌
  4. 📌 提交 Pull Request 并附带说明
  5. 📌 等待审核后合并 ✅

💡 遇到疑问?可参考 代码风格 FAQ 获取帮助 📚

贡献流程图