googleapis/google-http-java-client

Don't require javadoc for tests

Open

#1.267 geöffnet am 18. Feb. 2021

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (446 Forks)batch import
help wantedtype: cleanup

Repository-Metriken

Stars
 (1.312 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

I think this is a checkstyle config issue:

[INFO] Starting audit...
[WARN] /Users/elharo/google-http-java-client/google-http-client-test/src/main/java/com/google/api/client/test/util/store/AbstractDataStoreFactoryTest.java:62:3: Missing a Javadoc comment. [MissingJavadocMethod]
[WARN] /Users/elharo/google-http-java-client/google-http-client-test/src/main/java/com/google/api/client/test/util/store/AbstractDataStoreFactoryTest.java:86:3: Missing a Javadoc comment. [MissingJavadocMethod]
[WARN] /Users/elharo/google-http-java-client/google-http-client-test/src/main/java/com/google/api/client/test/util/store/AbstractDataStoreFactoryTest.java:126:3: Missing a Javadoc comment. [MissingJavadocMethod]

Contributor Guide

Research-Richtung
Ändern Sie die Checkstyle Konfiguration, um die MissingJavadocMethod Regel für Test Quellcode Verzeichnisse zu unterdrücken. Suchen Sie die Checkstyle Konfigurationsdatei (z. B. checkstyle.xml oder in pom.xml konfiguriert) und fügen Sie einen Ausschluss für das Testverzeichnis Muster hinzu, wie z. B. '**/test/**' oder ähnlich. Testen Sie, ob die Änderung funktioniert, indem Sie `mvn checkstyle:check` auf dem Modul ausführen.
Tech Stack
java
Domain
build systemdeveloper experience
Issue Type
Wartung
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.
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 programmingCheckstyle configuration
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80