ContainerSolutions/externalsecret-operator

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

Aperta

#136 aperta il 16 nov 2020

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Go (27 fork)auto 404
backend/alldocumentationgood first issue

Metriche repository

Star
 (192 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Aggiungi commenti in stile Go ai tipi, funzioni e metodi esportati seguendo gli esempi forniti in golang e argocd.
Tech stack
go
Dominio
backenddevops
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Go
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80