otto-de / otto-de/api-guidelines
[new rule] write domain events originating from the same entity type to the same kafka topic
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
The rule https://api.otto.de/portal/guidelines/r200017 implicitly states that domain events from the same entity type should be written to the same topic. This should be made explicit in a new rule.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing rule referenced as r200017 and review how rules are documented in this repository. Add a new rule making explicit that domain events from the same entity type are written to the same Kafka topic, then verify that the guideline wording is consistent with the surrounding rules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kafka
- Domain
- backend-api-design
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100