Contributing and Code Style

Contributing and Code Style

HightLight

• 可读性
  最重要。变量缩写要通用。
• 风格统一
  C++ 与 Kaldi 风格一致
  format code: python precommit; c++ clang-format google style.
• 可维护性

Projects

• 先将 plan 在 project中发布
• 开工前发布 issue
• 遗留项加入 project 的 plan
• 工作开始于此，结束于此

PR

• 小步快跑
• 大PR只有大 Feature 才可以
• 开工前先提 PR 便于协作和 review
• 每次PR需要填上：Project/Milestone 信息
• 如有关联的issue: Fix #333

Changlog

• 自动生成工具 https://github.com/github-changelog-generator/github-changelog-generator
• PaddleSpeech/PaddleAudio 下 CHANGELOG.md
• 按 Feature 添加，样例如下。需要清晰支持什么时间，加了什么功能，以便后续复盘使用。
  日期-【新增】Conformer ASR model

Reference

• ci/code style check