Contributing and Code Style

Jump to bottom

Hui Zhang edited this page Jan 17, 2022 · 33 revisions

Contributing and Code Style

HightLight

可读性
第一原则
风格统一
C++ 与 Kaldi 风格一致
Code Style
1. python: precommit run -a
2. c++: clang-format， google style
  docstring: 使用 Python Docstring Generator 插件，默认用 Google (default)
可维护性

Projects

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

PR

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

Changlog

PaddleSpeech/PaddleAudio 下 CHANGELOG.md
按 Feature 添加，样例如下。需要清晰支持什么时间，加了什么功能，以便后续复盘使用。
日期-【新增】Conformer ASR model

Reference