akka/akka-core

Rewrite Future docs, they miss to show best practices and traps

Offen

#23.948 geöffnet am 09.11.2017

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Scala (3.547 Forks)batch import
1 - triagedhelp wantedt:docs

Repository-Metriken

Stars
 (13.277 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 8T 19h) (10 gemergte PRs in 30 T)

Beschreibung

Current Future docs are rather ancient and focused on showing off the Future API, and Await actually. I think we're in real need of rewriting these two pages:

Contributor Guide

Research-Richtung
Überprüfe die aktuellen Future Dokumente unter den angegebenen URLs, identifiziere fehlende Best Practices (z.B. pipeTo, Vermeidung von Mutationen veränderlicher Zustände) und häufige Fallstricke, und schreibe beide Seiten mit vollständigen Beispielen und Warnungen neu.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitAkka
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70