otto-de / otto-de/api-guidelines
[new rule] guidelines for avro format
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
Multiple teams expressed the desire to use something other than JSON to encode messages on Kafka. While the Event-Guidelines does not restrict the usage of another format, it also provides no guidance how to properly use another format.
As most of the kafka ecosystem is working with avro, we will focus on the evaluation of guidelines for the avro format.
Tasks
- Check the existing guidelines for JSON if they also apply to the avro format.
- Check if additional rules make sense
- Update the guidelines accordingly to include rules for Avro
Reference
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 reading the existing JSON guidelines in the repository and the Apache Avro reference linked in the issue. Compare the JSON rules with Avro usage in Kafka messages, identify any additional rules needed, and update the guidelines so Avro-specific guidance is included and complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kafka
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100