googleapis/google-http-java-client

Don't require javadoc for tests

Open

#1 267 ouverte le 18 févr. 2021

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Java (446 forks)batch import
help wantedtype: cleanup

Métriques du dépôt

Stars
 (1 312 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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]

Guide contributeur

Direction de recherche
Modifiez la configuration Checkstyle pour supprimer la règle MissingJavadocMethod pour les répertoires de code source de test. Recherchez le fichier de configuration Checkstyle (par exemple checkstyle.xml ou configuré dans pom.xml) et ajoutez une exclusion pour le motif de répertoire de test, tel que '**/test/**' ou similaire. Testez que le changement fonctionne en exécutant `mvn checkstyle:check` sur le module.
Stack technique
java
Domaine
build systemdeveloper experience
Type d'issue
Maintenance
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Java programmingCheckstyle configuration
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80