KusionStack / konfig

Shared repository of application models and components, and CI suite for GitOps workflows
Apache License 2.0
27 stars 32 forks source link

chore: fix inconsistency between schema field property and comment #58

Closed howieyuen closed 1 year ago

howieyuen commented 1 year ago

related issue: https://github.com/KusionStack/konfig/issues/59

main changes:

  1. schema 注释在与多行注释符号(""")间隔一个空格符,换行后与首个引号对齐
  2. 缩进统一为 4 个空格,字段注释格式:<field name>: <field type>, <default value>, <required or optional>.
  3. 同包的 schema 引用,不需要包名
  4. 不同包 schema 引用,使用 import 路径最后一级目录名,有 import 别名,优先使用别名
  5. 有字段无注释,无字段有注释
  6. 字段类型与注释不匹配 字段属性与注释不匹配