akka/akka-core

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

Ouverte

#23 948 ouverte le 9 nov. 2017

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)Scala (3 547 forks)batch import
1 - triagedhelp wantedt:docs

Métriques du dépôt

Stars
 (13 277 étoiles)
Métriques de merge PR
 (Merge moyen 8j 19h) (10 PRs mergées en 30 j)

Description

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:

Guide contributeur

Direction de recherche
Examinez la documentation actuelle de Future aux URL fournies, identifiez les meilleures pratiques manquantes (par exemple, pipeTo, éviter les mutations d'état mutable) et les pièges courants, puis réécrivez les deux pages avec des exemples complets et des avertissements.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitAkka
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70