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

Doc: Create use case and requirements on TEA Events

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Start by reading the linked tea-publish.pdf presentation and comparing it with the existing customer and publisher API documentation. Identify the intended TEA Events use case and requirements, then document them alongside those APIs. Done means the use case and requirements are clearly captured, though the issue does not name a target file or format.

Written by the indexing model from the issue text.

Description

Backlog documentation TEA Events

We need to add TEA Events along side with customer and publisher API.

There is some documentation here:
https://github.com/CycloneDX/transparency-exchange-api/blob/main/presentations/oej/tea-publish.pdf

Dominant language
Shell
Stars
116
Forks
23
Avg merge
1d 3h
Merged PRs (30d)
58

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.