AbsaOSS/enceladus

Add scaladocs

Open

#63 opened on Dec 2, 2018

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Scala (16 forks)auto 404
ConformanceMenasStandardizationdocsgood first issuepriority: low

Repository metrics

Stars
 (33 stars)
PR merge metrics
 (PR metrics pending)

Description

We lack scaladocs on most APIs, would really help to improve documentation.

Contributor guide

Research direction
Review the codebase to identify APIs missing Scaladoc, then write descriptive Scaladoc comments following the project's conventions.
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
ScalaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70