CycloneDX/sbom-utility

TODO: Change Formulation and ModelCard schemas to use pointers

Open

#79 opened on Apr 1, 2024

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Go (20 forks)auto 404
enhancementgood first issuehelp wanted

Repository metrics

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

Description

The CycloneDX schema file:

/Users/Matt_1/Projects/CycloneDX/sbom-utility/schema/cyclonedx_formulation.go

defines all the structures used for "formulation" which was added in v1.5; however, these structs should be updated to use pointers to structs in all cases to improve performance during JSON Marshal (decoding).

The same should be done for the added ModelCard data (as part of the Component type):

/Users/Matt_1/Projects/CycloneDX/sbom-utility/schema/cyclonedx_modelcard.go

Contributor guide

Research direction
Identify all struct definitions in cyclonedx formulation.go and cyclonedx modelcard.go that are not using pointers, then change their fields to pointer types to improve performance during JSON unmarshalling. Ensure nil checks are handled in downstream code.
Tech stack
go
Domain
backend
Issue type
Refactor
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.
65