ovn-kubernetes/libovsdb

Package Documentation

Open

#140 opened on May 27, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (164 forks)auto 404
featuregood first issue

Repository metrics

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

Description

We have some documentation, but it's not extensive. We should ensure that:

  1. All packages have a doc.go
  2. All functions that are part of the package API have good documentation
  3. Function comments can avoid mentioning types (e.g does foo with a model.Model) as links are already populated in the godoc.
  4. Examples should be in a doc_test.go file see. This ensures that they compile and won't be forgotten with API changes

Contributor guide

Research direction
Identify packages missing doc.go and functions with incomplete comments. Add documentation following Go conventions and ensure examples compile.
Tech stack
go
Domain
backend
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.
Active
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