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 摘要。