akka/akka-core

It will kind to add "include"s to code exaples to simplify cut'n'paste for lay people

Open

#21,626 opened on Oct 5, 2016

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

Repository metrics

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

Description

Really it's annoing to investigate symbol origins, while some half of people not use ides with completing

Contributor guide

Research direction
Locate the documentation files containing code examples in the Akka core repository, identify examples that lack import statements, and add the necessary import includes to allow users to copy and paste the code directly without investigating symbol origins.
Tech stack
scala
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitScala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85