Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

unclear requirement

Open Beginner friendly
#394 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Domain
api, documentation

Research direction

Open discovery/readme.md at the linked section around line 112 and read the surrounding discovery lookup requirements. Confirm with maintainers whether the wording is normative and which list behavior is intended; done means the specification states the requirement unambiguously.

Written by the indexing model from the issue text.

Description

TEI Discovery

https://github.com/CycloneDX/transparency-exchange-api/blob/70653a9b4fe8032e13ee12cdc8c4f7c6d3a6aae5/discovery/readme.md?plain=1#L112

Does this mean discovery lookups always return a list, even if the length would be 1? or does it mean discovery lookups may return a list?

For this reason discovery lookups always return a list,
For this reason discovery lookups may in some scenarios return a list,

Or is this a proper requirement?

Discovery lookups shall return a list ordered by priority and containing all product releases associated with the requested TEI.
Dominant language
Shell
Stars
116
Forks
23
Avg merge
2d 11h
Merged PRs (30d)
63

Getting set up

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.

More from CycloneDX/transparency-exchange-api

All issues in CycloneDX/transparency-exchange-api

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.