AbsaOSS/enceladus

Add scaladocs

Offen

#63 geöffnet am 02.12.2018

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Scala (16 Forks)auto 404
ConformanceMenasStandardizationdocsgood first issuepriority: low

Repository-Metriken

Stars
 (33 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfen Sie die Codebasis, um APIs zu identifizieren, denen Scaladoc fehlt, und schreiben Sie dann beschreibende Scaladoc Kommentare gemäß den Projektkonventionen.
Tech Stack
scala
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
ScalaGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70