ContainerSolutions/externalsecret-operator

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

Ouverte

#136 ouverte le 16 nov. 2020

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Go (27 forks)auto 404
backend/alldocumentationgood first issue

Métriques du dépôt

Stars
 (192 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Ajoutez des commentaires de style Go aux types, fonctions et méthodes exportés en suivant les exemples fournis dans golang et argocd.
Stack technique
go
Domaine
backenddevops
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Go
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80