ContainerSolutions/externalsecret-operator

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

Offen

#136 geöffnet am 16.11.2020

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (27 Forks)auto 404
backend/alldocumentationgood first issue

Repository-Metriken

Stars
 (192 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Fügen Sie Go artige Kommentare zu exportierten Typen, Funktionen und Methoden hinzu, indem Sie den Beispielen in golang und argocd folgen.
Tech Stack
go
Domain
backenddevops
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Go
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80