akka/akka-core

Remove some non-helpful phrases from the docs

Open

#27,792 opened on Sep 25, 2019

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Scala (3,547 forks)batch import
help wantedt:docs

Repository metrics

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

Description

Most of us being non native english speakers we tend to accidentally use phrasing that is a bit condescending and not helpful in any way, we should remove such from the docs.

  • of course
  • obviously
  • simply
  • easily

Contributor guide

Research direction
Scan the documentation for occurrences of 'of course', 'obviously', 'simply', and 'easily'. Remove or rephrase to make the docs more inclusive and clear.
Tech stack
scala
Domain
None
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90