akka/akka-http

Add docs for using testkits with Junit 5

Offen

#2.573 geöffnet am 17.06.2019

Auf GitHub ansehenContributor Guide
 (5 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Scala (598 Forks)batch import
1 - triagedhelp wantedt:docst:testing

Repository-Metriken

Stars
 (1.311 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 1T 10h) (2 gemergte PRs in 30 T)

Beschreibung

Sister-ticket of akka/akka#27155

We since previously have a request to migrate to JUnit 5 but since the demand has been so low I'm not sure if we want to do that, however, I think we should show in docs how to use the testkit with JUnit 5

Alpakka Kafka has done this in the docs here https://doc.akka.io/docs/alpakka-kafka/current/testing.html#testing-from-java-code

Contributor Guide

Research-Richtung
Das Issue fordert die Ergänzung der Dokumentation zur Verwendung von Testkits mit JUnit 5, ähnlich wie es Alpakka Kafka macht (https://doc.akka.io/docs/alpakka kafka/current/testing.html#testing from java code). Die Lösung besteht darin, die vorhandene Akka HTTP Testdokumentation (wahrscheinlich im Verzeichnis `docs/src/main/paradox/`) zu finden und einen neuen Abschnitt oder eine neue Seite hinzuzufügen, die die Verwendung des Testkits mit JUnit 5 demonstriert. Das Schwester Ticket akka/akka#27155 könnte zusätzlichen Kontext enthalten. Der Beitragende sollte auch die vorhandenen Kommentare auf frühere Diskussionen oder Vorschläge überprüfen.
Tech Stack
scalajava
Domain
documentationbackend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
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
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90