Update the contribution guide #5104
Conversation
github contributing steps
Create new chapter of style guide and references
guide for new API code development.
update the contribution guide structure.
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-5104.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
|
|
||
| ## 一、飞桨原生算子 API 开发解读 | ||
|
|
||
| 飞桨框架 API 前端采用 Python 语言，以便获得更好的编程体验；后端的计算逻辑实现采用 C++ 语言，调用底层算子内核 （kernel）函数实现计算逻辑，以便获得更好的运行性能，如图1所示。 |
| 当 API 设计文档合入后，开发者即可进行代码开发。此过程请参考相应的开发规范，包括如下步骤： | ||
|
|
||
| - 如果新增 API 不需要开发新的 C++ OP，可以用其他 Python API 组合得到新的 API，请参考 [开发 API Python 端](new_python_api_cn.html) 章节完成，包括开发 Python 代码、单元测试代码和 API 文档等步骤。 | ||
| - 如果新增 API 需要开发新的 C++ OP，请参考 [开发 C++ OP](new_cpp_op_cn.html) 章节完成，包括开发 OP 实现代码、封装 Python API 代码、单元测试代码和 API 文档等步骤。 |
There was a problem hiding this comment.
[开发 C++ OP] 最新文档里标题更新为了 [C++ 算子开发指南]
|
|
||
|  | ||
|
|
||
| 如果CI失败你无法判断原因，请联系 @[lelelelelez](https://github.com/lelelelelez)。 |
|
|
||
| 通常你需要提前阅读本章节，以及通用的 [规范和参考信息](style_guide_and_references/index_cn.html)，然后根据贡献内容阅读对应模块的指南，比如需要贡献一个新的 API，则需阅读 [新增 API 贡献指南](api_contributing_guides/api_contributing_guides_cn.html)，后续飞桨也将提供其他的如功能增强、性能优化等相关贡献指南，当然也欢迎开发者贡献这些指南。 | ||
|
|
||
| > 说明：文档的贡献流程与代码有所不同，可直接阅读 [文档贡献指南](docs_contributing_guides_cn.html) 即可。 |
There was a problem hiding this comment.
可直接阅读 文档贡献指南 即可。
这俩「可」删一个吧？
|
|
||
| ```bash | ||
| # Clone Paddle 仓库到本地并进入 Paddle 文件夹 | ||
| ➜ git clone https://github.com/USERNAME/Paddle |
There was a problem hiding this comment.
已提issue跟踪该问题：#5120
|
|
||
| （1）提交设计文档（可选） | ||
|
|
||
| 针对比较复杂/重要的变更，如新增 API、算子性能优化等，建议你先向 [PaddlePaddle/community](https://github.com/PaddlePaddle/community) 中的 `rfcs`对应的目录，按 [模板](https://github.com/PaddlePaddle/community/blob/master/rfcs/APIs/api_design_template.md) 提交 RFC，待社区讨论通过后，再进行下一步的功能开发。 |
There was a problem hiding this comment.
这里建议加一个备注，如果仅有设计思路或不确定是否可以贡献，可以先向 Paddle 仓库提 issue，提前和飞桨团队沟通大致内容。飞桨社区活动总览 以及 PFCC-Roadmap 总览 中的任务是已经经过确认的，可以直接提交设计文档。
|
|
||
| 收到 Code Review 意见后，请参考 [Code Review注意事项](#CodeReview) 回复评审人的意见，并根据意见修改代码。 | ||
|
|
||
| > 注意：请确保 CI 测试中每一项都通过，如果没过，说明提交的代码存在问题，评审人一般不做评审。 |
There was a problem hiding this comment.
应该是除 pr approve 之外的CI测试每一项都通过，如果没有通过，请通过报错信息自查代码
There was a problem hiding this comment.
done. 修改注意事项，并挪到上一个步骤中。
注意：PR-CI-APPROVAL 和 PR-CI-Static-Check 这两个 CI 测试项可能需要飞桨相关开发者 approve 才能通过，除此之外请确保其他每一项都通过，如果没有通过，请通过报错信息自查代码。
| 当提交的 Pull Request（PR）Merge 到 Paddle 仓库后，飞桨团队相关人员会对整个框架功能进行集成测试，集成测试用于模型、API、OP 等的功能和性能测试。 | ||
|
|
||
| - 如果测试通过，恭喜你贡献流程已经全部完成； | ||
| - 如果测试不通过，我们会在 GitHub 发 Issue 联系你进行代码修复，请及时关注 GitHub 上的最新动态。 |
There was a problem hiding this comment.
发issue联系？一般是在pr里@吧，这个可能需要和QA同学确认下流程~
There was a problem hiding this comment.
QA同学已确认，是按这个流程，不过目前还未发现这种情况。
| - 如果测试通过，恭喜你贡献流程已经全部完成； | ||
| - 如果测试不通过，我们会在 GitHub 发 Issue 联系你进行代码修复，请及时关注 GitHub 上的最新动态。 | ||
|
|
||
| > 说明：代码合入 Paddle develop 分支后的第二天，即可从飞桨官网下载 develop 版本的编译安装包体验此功能。飞桨后续也会将此功能纳入正式版的发版计划。 |
There was a problem hiding this comment.
done.最后一句『飞桨后续也会将此功能纳入正式版的发版计划。』更改为『通过测试的代码会被纳入正式版的发版计划。』
| @@ -0,0 +1,243 @@ | |||
| # Paddle CI 测试详解 | |||
There was a problem hiding this comment.
只是挪了位置。删除copy件，改为链接到原内容。
Update the contribution guide structure and some topics.