apache/beam

Re-enable checkstyle JavadocParagraph

Offen

#18.964 geöffnet am 03.06.2022

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (4.097 Forks)batch import
P3buildgood first issueimprovement

Repository-Metriken

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

Beschreibung

When spotless reformats javadoc, many of our javadoc comments are revealed to be broken, missing paragraph tags. Rather than force them all to be fixed in a single PR, we could disable the check and do it a few at a time, since it is easy "idle hands" work. This JIRA tracks that (the actual disabling is not yet committed).

Imported from Jira BEAM-4670. Original Jira may contain additional context. Reported by: kenn.

Contributor Guide

Research-Richtung
Deaktivieren Sie die checkstyle JavadocParagraph Prüfung in der Build Konfiguration (z. B. pom.xml oder checkstyle Konfigurationsdatei) und beheben Sie möglicherweise einige javadoc Probleme.
Tech Stack
java
Domain
toolingbuild system
Issue Type
Wartung
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Java
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85