akka/akka-core

Document the pluggable DnsProvider

Open

#21,171 opened on Aug 10, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (3,547 forks)batch import
1 - triagedhelp wantedt:io

Repository metrics

Stars
 (13,277 stars)
PR merge metrics
 (Avg merge 8d 19h) (10 merged PRs in 30d)

Description

The DnsProvider is a pluggable by-class-name provider but there is essentially no docs at all on the plugin interfaces, given that it has two methods that return Class[_ <: Actor] I think there is room for some improvements here, what is each actor supposed to do, what constructor parameters should it take, how is it supervised, what happens if it stops, what messages should it accept and respond to. etc.

Contributor guide

Research direction
Read the existing DnsProvider source code and the Akka actor documentation to document the plugin interface, including constructor parameters, supervision strategy, expected messages, and lifecycle.
Tech stack
scala
Domain
backendinfrastructure
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
AkkaScala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65