angular / angular/angularfire

Recommended API Version

未关闭
#3,336 2 条评论 5 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
TypeScript
星标
7.8k
派生
2.2k
平均合并
22 小时 28 分钟
30 天内合并 PR
6

描述

First, the [Example Use](https://github.com/angular/angularfire#developer-guide) section of the README has examples using the Modular API. Then, in the [Resources](https://github.com/angular/angularfire#resources) section of the README, we're first directed to the [version 7 upgrade guide](https://github.com/angular/angularfire/blob/master/docs/version-7-upgrade.md) that specifically mentions in bolded text:

> **Most developers can stop here for now as the new API isn't feature complete.**

Finally, the README then proceeds to the [Developer Guide](https://github.com/angular/angularfire#developer-guide) section that again links to the upgrade doc, but then specifically calls out that it assumes we're using the Modular API. Even the new issue instructions recommend that we read said Developer Guide, indicating that perhaps the Modular API should be what we're using.

While I would like a direct answer as to which is the currently recommended version, I'm guess that it's the Modular API and that the version 7 upgrade document is out of date. If that's correct, and the Modular API is now feature complete, then it should be updated to prevent this type of confusion.

贡献指南

打开贡献指南

调研方向

将 README 的 Example Use、Resources 和 Developer Guide 部分与 docs/version-7-upgrade.md 进行比较,尤其关注关于 Modular API 尚不完整的表述。与项目维护者确认当前推荐的 API,然后使 README 和升级指南保持一致,并验证冲突的指导内容已被移除。

由索引模型根据 Issue 内容生成。

评估

技术栈
angular, firebase, typescript
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。