ContainerSolutions/externalsecret-operator

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

Open

#136 opened on Nov 16, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (27 forks)auto 404
backend/alldocumentationgood first issue

Repository metrics

Stars
 (192 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Add Go style comments to exported types, functions, and methods following the examples provided in golang and argocd.
Tech stack
go
Domain
backenddevops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80