googleapis/google-http-java-client

Don't require javadoc for tests

Open

#1.267 aberto em 18 de fev. de 2021

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Java (446 forks)batch import
help wantedtype: cleanup

Métricas do repositório

Stars
 (1.312 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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]

Guia do colaborador

Direção de pesquisa
Modifique a configuração do Checkstyle para suprimir a regra MissingJavadocMethod para diretórios de código fonte de teste. Procure o arquivo de configuração do Checkstyle (por exemplo, checkstyle.xml ou configurado em pom.xml) e adicione uma exclusão para o padrão do diretório de teste, como '**/test/**' ou similar. Teste se a alteração funciona executando `mvn checkstyle:check` no módulo.
Pilha de tecnologia
java
Domain
build systemdeveloper experience
Tipo Issue
Manutenção
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Java programmingCheckstyle configuration
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80