Skip to content

Commit

Permalink
docs: add note about data stability over time
Browse files Browse the repository at this point in the history
  • Loading branch information
mariajgrimaldi committed Dec 20, 2024
1 parent 297069f commit 28845d0
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/how-tos/create-a-new-event.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@ This will help ensure that the event is self-descriptive and self-contained as m

.. note:: There has been cases where events also carry other contextual data not directly related to the event but useful for consumers. Although this is not recommended, if you need to include such data, ensure that the reasoning behind it is documented and does not introduce ambiguity.

.. note:: Also consider how relevant is the data to where the event is triggered. Consider whether it could be removed or deprecated in the future so that the event remains consistent and maintainable over time.

Step 5: Implement the Event Definition and Payload
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 28845d0

Please sign in to comment.