Back to Details

atlan-review-doc-sync

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Atlan Review Doc Sync

Atlan 评审文档同步

Produce high-signal review findings and keep docs aligned.
输出高价值的评审结论，保证文档与实现对齐。

Workflow

工作流

  1. Review code and tests with bug/risk/regression priority.
  2. Report findings first, then brief change summary.
  3. Update app-level docs (README, architecture notes, test notes) to match actual behavior.
  4. Run 
    atlan-fact-verification-gate
    if behavior-critical claims need source confirmation.
  5. Validate implementation against selected quality tier from 
    ../_shared/references/app-quality-bar.md
    .
  6. Confirm SDK/CLI remain untouched.
  7. If CLI mismatch surfaced during review, append proposal entry.
  1. 按bug/风险/回归问题的优先级评审代码和测试用例。
  2. 优先上报评审发现的问题，再简述变更概要。
  3. 更新应用级文档（README、架构说明、测试说明），使其与实际行为一致。
  4. 若涉及影响行为的关键声明需要来源确认，运行
    atlan-fact-verification-gate
    。
  5. 参照
    ../_shared/references/app-quality-bar.md
    中选定的质量等级，验证实现是否符合要求。
  6. 确认SDK/CLI未被修改。
  7. 若评审过程中发现CLI不匹配的问题，追加提案条目。

Rules

规则

  • Prioritize correctness, regression risk, and missing tests.
  • Keep review findings concrete with file references.
  • Do not modify SDK or CLI docs/code.
  • 优先关注正确性、回归风险和缺失的测试用例。
  • 评审结论要具体，附带文件引用路径。
  • 不得修改SDK或CLI的文档/代码。

References

参考资料

  • Review checklist: 
    references/review-checklist.md
  • Quality bar: 
    ../_shared/references/app-quality-bar.md
  • CLI proposals: 
    ../_shared/references/cli-change-proposals.md
  • 评审检查清单：
    references/review-checklist.md
  • 质量标准：
    ../_shared/references/app-quality-bar.md
  • CLI 提案：
    ../_shared/references/cli-change-proposals.md