github / github/go-spdx

DOCUMENTATION: add package level documentation and files level documentation for all files

Open
#5 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Go
Stars
53
Forks
16
PR merge metrics
No merged PRs in 30d

Description

Add documentation explaining major concepts and purpose for each file.

Add package level documentation that describes interconnections between major concepts in different files and how to use public API.

_NOTE: Use `Go` for identifying the go language. There is at least one use of `GO` in the code documentation.`

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.