diff options
Diffstat (limited to 'doc/development/snowplow/review_guidelines.md')
| -rw-r--r-- | doc/development/snowplow/review_guidelines.md | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/doc/development/snowplow/review_guidelines.md b/doc/development/snowplow/review_guidelines.md index ee2c1eb95df..d5432cc9075 100644 --- a/doc/development/snowplow/review_guidelines.md +++ b/doc/development/snowplow/review_guidelines.md @@ -1,13 +1,13 @@ --- stage: Analytics -group: Product Intelligence +group: Analytics Instrumentation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Snowplow review guidelines -This page includes introductory material for a -[Product Intelligence](https://about.gitlab.com/handbook/engineering/development/analytics/product-intelligence/) +This page includes introductory material for an +[Analytics Instrumentation](https://about.gitlab.com/handbook/engineering/development/analytics/analytics-instrumentation/) review, and is specific to Snowplow related reviews. For broader advice and general best practices for code reviews, refer to our [code review guide](../code_review.md). @@ -18,7 +18,7 @@ general best practices for code reviews, refer to our [code review guide](../cod ## Review process -We recommend a Product Intelligence review when a merge request (MR) involves changes in +We recommend an Analytics Instrumentation review when a merge request (MR) involves changes in events or touches Snowplow related files. ### Roles and process @@ -28,16 +28,17 @@ events or touches Snowplow related files. - For frontend events, when relevant, add a screenshot of the event in the [testing tool](implementation.md#develop-and-test-snowplow) used. - For backend events, when relevant, add the output of the - [Snowplow Micro](implementation.md#snowplow-micro) good events + [Snowplow Micro](implementation.md#test-backend-events-with-snowplow-micro) good events `GET http://localhost:9090/micro/good` (it might be a good idea to reset with `GET http://localhost:9090/micro/reset` first). -- Update the [Event Dictionary](event_dictionary_guide.md). +- Add or update the event definition file according to the [Event Dictionary Guide](event_dictionary_guide.md). -#### The Product Intelligence **reviewer** should +#### The Analytics Instrumentation **reviewer** should - Check that the [event schema](index.md#event-schema) is correct. - Check the [usage recommendations](implementation.md#usage-recommendations). -- Check that the [Event Dictionary](event_dictionary_guide.md) is up-to-date. +- Check that an event definition file was created or updated in accordance with the [Event Dictionary Guide](event_dictionary_guide.md). - If needed, check that the events are firing locally using one of the [testing tools](implementation.md#develop-and-test-snowplow) available. - Approve the MR, and relabel the MR with `~"product intelligence::approved"`. +- If the snowplow event mirrors a RedisHLL event, then tag @mdrussell to review if the payload is usable for this purpose. |