googleapis/google-http-java-client

Don't require javadoc for tests

Open

#1267 aperta il 18 feb 2021

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Java (446 fork)batch import
help wantedtype: cleanup

Metriche repository

Star
 (1312 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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]

Guida contributor

Direzione di ricerca
Modifica la configurazione di Checkstyle per sopprimere la regola MissingJavadocMethod per le directory di sorgenti di test. Cerca il file di configurazione di Checkstyle (ad esempio checkstyle.xml o configurato in pom.xml) e aggiungi un'esclusione per il pattern della directory di test, come '**/test/**' o simile. Verifica che la modifica funzioni eseguendo `mvn checkstyle:check` sul modulo.
Tech stack
java
Dominio
build systemdeveloper experience
Tipo issue
Manutenzione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Java programmingCheckstyle configuration
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80