Skip to content

lark: Rename and document `:update` event to `:change_properties`

tamsin woo requested to merge lark-attributes-event into master

Local Checklist

  • Read our Contributing guide (for newcomers)
  • Tests written and passing locally?
  • Code style checked?
  • QA-ed locally?
  • Rebased with master branch?
  • Configuration updated (if needed)?
  • Documentation updated (if needed)?

What does this Merge Request do?

Proposes a rename of :update to :change_properties, and adds a required changes key to the event's data. Initial documentation is added for the new event type.

This is the outcome of discussion with @lsitu; but the proposed new name is somewhat arbitrary. Suggestions are welcome. It's important that event semantics get nailed down before any production events go in the log. Once they are in, we need to support them for the life of the app.

Why are we doing this? Any context of related work or Epic?

This is part of a longer refactor related to #31 (closed).

Where should a reviewer start?

Read the initial documentation in EVENT_LOG.md, consider whether this approach is likely to work for all kinds of updates where we apply changes to the properties of existing records.

Merge request reports