akka/akka-core

Streams Contributors guide

Open

#19,793 opened on Feb 16, 2016

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

Repository metrics

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

Description

Let's compile a minidoc for contributors on when, how and where to add new combinators. There are many questions here that needs at least some fuzzy initial guidance:

what combinators do we accept? Of course this is not definable, but sometimes it is easier to show some counterexamples that are trivially no-go if a combinator is to be accepted, where should it go? I.e. FlowOps, Source, Sink or external object if accepted and goes into the FlowOps/Source/Sink APIs then describe all the places where modifications needs to be done establish a guideline for testing these and documenting these

Contributor guide

Research direction
Review existing Akka Streams documentation and source code to understand current patterns for combinators, then draft a guide covering acceptance criteria, placement guidelines, modification points, and testing/documentation standards.
Tech stack
scala
Domain
documentation
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-2 days
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.
Clear
Prerequisites
Akka StreamsGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60