为Ember.js提交PR时如何查找仓库文档对应源文件
Ember.js 开源贡献文档源查找指南
Ember.js主仓库没有独立存放的成品文档文件,所有官方API文档都是从源码内的标注内容自动构建生成的,你要修改文档直接从以下几个位置入手即可:
- 核心API文档的源内容全部存放在
packages/目录下对应功能模块的源码文件里。每个模块、公开方法、属性的上方都有标准JSDoc注释块,这部分内容就是官方API文档的核心来源,你定位到对应issue涉及的功能源码,直接修改对应JSDoc注释的内容即可。 - 如果你要修改的是使用指南、入门教程类的非API文档,这部分内容不在ember.js主代码仓库中,归属Ember官方文档维护组的专门仓库管理,主仓库内找不到对应源文件。
- 和TS类型提示绑定的文档补充内容,存放在仓库根目录的
types/文件夹下,对应模块的.d.ts类型声明文件里的注释,会同时被抽出来作为API文档的补充内容、以及编辑器里的TS类型提示内容,如果涉及类型相关的文档说明,记得同步修改这里的内容。 - 本地验证文档修改效果可以直接运行根目录的命令:
npm run docs:build可以在本地生成完整的静态文档站点,npm run docs:serve可以启动本地预览服务直接查看渲染后的效果,提交前可以先跑一遍检查格式、内容有没有错误。
小提示:纯文档类的PR建议在标题前加上[DOC]前缀,方便维护者快速分类筛选,这类PR不需要补充功能测试用例,只要JSDoc格式合规、本地预览渲染正常就满足提交要求。
内容的提问来源于stack exchange,提问作者Kirtan Desai
相关产品推荐
相关产品推荐

