vmware / vmware/go-ipfix

Documentation for go-ipfix library

Open
#54 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
52
Forks
34
Avg merge
9h 39m
Merged PRs (30d)
7

Description

  • Documentation for abstraction of pkg/entities or in general code structure.
  • Documentation for exporter
  • Documentation for collector
  • Documentation for intermediate process
  • Documentation for kafka producer

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading pkg/entities and then locate the exporter, collector, intermediate process, and Kafka producer packages in the repository. Document the abstraction and overall code structure plus each listed component, with coverage of all five checklist items as the completion criterion.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.