INRIA/spoon

good first issue: add documentation for 3 undocumented public methods

Aberta

#1.876 aberto em 22 de fev. de 2018

Ver no GitHubGuia do colaborador
 (8 comentários) (0 reação) (0 responsável)Java (383 forks)github user discovery
documentationgood first issue

Métricas do repositório

Stars
 (1.933 estrelas)
Métricas de merge de PR
 (Mesclagem média 19d 11h) (49 fundiu PRs em 30d)

Description

In Spoon, we want that all public methods are properly documented.

We have a test case to check this: https://github.com/INRIA/spoon/blob/51c4b2211922e71914f74ce4341a6232c079f174/src/test/java/spoon/test/architecture/SpoonArchitectureEnforcerTest.java#L120

This test case temporarily skips small methods.

To get this issue done:

  • List the undocumented public methods:
    • lower the threshold size() > 33 in the test case
    • run the test case, this will list you undocumented public methods
  • Add appropriate Javadoc documentation /** .... */
  • Create a pull request with your changes

Guia do colaborador

Direção de pesquisa
Reduza o limite no arquivo de teste para listar métodos públicos não documentados e adicione comentários Javadoc a cada método.
Pilha de tecnologia
java
Domain
tooling
Tipo Issue
Documentaçã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.
1
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.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90