OpenFeign/feign

Update Java Doc

Open

#772 aberto em 16 de ago. de 2018

Ver no GitHub
 (0 comments) (1 reaction) (0 assignees)Java (1.911 forks)batch import
documentationhelp wanted

Métricas do repositório

Stars
 (9.070 stars)
Métricas de merge de PR
 (Mesclagem média 3d 8h) (59 fundiu PRs em 30d)

Description

The current set of Java Doc is old and in some cases, misleading. Also, during a release, there are a number of items missing.

Guia do colaborador

Direção de pesquisa
Comece identificando os arquivos JavaDoc atuais no repositório. Compare com o comportamento real do código, observando quaisquer partes desatualizadas ou enganosas. Examine os commits recentes e as notas de versão para ver quais recursos ou alterações estão faltando na documentação. Considere adicionar JavaDoc ausentes para novas classes ou métodos. A questão carece de exemplos específicos, então pode ser necessário examinar a base de código e abrir um problema de acompanhamento se o escopo for muito amplo.
Pilha de tecnologia
java
Domain
documentationapi
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.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
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.
Precisa de investigação
Prerequisites
JavaJavaDoc knowledgefamiliarity with Feign
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40