angular / angular/angularfire

Recommended API Version

Offen
#3,336 2 Kommentare 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TypeScript
Sterne
7.8k
Forks
2.2k
Ø Merge
22 Std. 28 Min.
Gemergte PRs (30 T.)
6

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Vergleiche die Abschnitte Example Use, Resources und Developer Guide des README mit docs/version-7-upgrade.md, insbesondere die Aussagen darüber, dass die Modular API unvollständig ist. Bestätige die derzeit empfohlene API mit den Projektbetreuern und passe anschließend das README und den Upgrade-Leitfaden so an, dass sie konsistent sind, und überprüfe, dass die widersprüchlichen Hinweise entfernt wurden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
angular, firebase, typescript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.