配置文件

  • 推荐使用开发语言无关的格式，如 yaml, toml, ini 等。
  • 常规配置放在 yaml 文件中，敏感信息放到 .env 文件中。

命名规范

  • 文件名或目录名推荐使用 snake_case 或 kebab-case ，小写字母，下划线分隔；避免使用大写字母和数字；关于连字符 hyphen 还是下划线 underscore，可以根据下方规则进行选择：

    • kebab-case ：如果主要关注可读性和SEO，建议使用连字符。文本文件推荐使用该方式；
    • snake_case ：如果更重视编程兼容性，或在命令行中使用，推荐使用下划线。代码文件推荐使用该方式；

  • snake_case 如果包括多个词时，推荐使用 动作 + 对象，这样比较符合命名习惯（像 Django、Flask、Airflow 等框架内部都是这种规则）。