otto-de / otto-de/api-guidelines

[update] definition of domain event

Open
#25 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
50
Forks
16
PR merge metrics
No merged PRs in 30d

Description

(i) This issue has been manually transferred from a former internal repository, as a private repository issue cannot be transferred to a public repository.

Context

Notes from discussion of 2022/07/08:

  • domain events can contain the whole data structure. They are still domain events because they have been triggered by an occurrence in the domain that is contained within the domain event.
  • Add a decision table / example table when to use what (e.g., log compaction)
  • Consumers of data events should not care about the order of events

Contributor guide

Open the contributing guide

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.

Research direction

No file or test is named; first locate the existing documentation section defining domain events in this API-guidelines repository. Use the 2022/07/08 discussion notes as requirements, and consider the work done when the definition, decision/example table, and event-order guidance are documented.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.