ContainerSolutions/externalsecret-operator

Improve our code comments to better leverage go docs and generate documentation from it

Aberta

#136 aberto em 16 de nov. de 2020

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Go (27 forks)auto 404
backend/alldocumentationgood first issue

Métricas do repositório

Stars
 (192 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Describe the solution you'd like Title says it. We can keep our interfaces/functions/structures/API easily documented by keeping our docs embedded to our code, exporting it from code comments with go docs.

What is the added value? Contributors can focus on writing their code and already document it in only one go.

Give us examples of the outcome

Guia do colaborador

Direção de pesquisa
Adicione comentários no estilo Go aos tipos, funções e métodos exportados seguindo os exemplos fornecidos em golang e argocd.
Pilha de tecnologia
go
Domain
backenddevops
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.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Go
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80