Overuse of "metadata" as a phrase
- Dominant language
- Go
- Stars
- 9.6k
- Forks
- 954
- Avg merge
- 23h 27m
- Merged PRs (30d)
- 48
Description
Metadata is defined as data that describes other data. There are a lot of places in the code where "metadata" is used incorrectly --that is, it isn't "metadata" is should just be "data", "extraData", "auxillaryData", or similar. The most prominent example of this is the `pkg.Package.Metadata` field.
We should be more careful with this word choice and replace any instance that isn't accurate with another word.
Note: this has been exposed in the syft JSON format as well, so any change here may have impacts with the JSON schema.
Contributor guide
Research direction
Start by reviewing the `pkg.Package.Metadata` field and its use in the code, then check how it appears in the Syft JSON format and schema. Identify uses of “metadata” that do not describe data about other data; done means those uses have accurate names and any JSON schema impacts are addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100