除雪車レビューガイドライン

このページにはAnalytics Instrumentationレビューのための入門的な資料が含まれており、Snowplow関連のレビューに特化しています。より広範なアドバイスやコードレビューの一般的なベストプラクティスについては、コードレビューガイドを参照してください。

レビュアー向けリソース

レビュープロセス

マージリクエスト（(MR) ）がイベントの変更を含む場合、またはSnowplow関連ファイルに触れる場合は、Analytics Instrumentationのレビューをお勧めします。

ロールとプロセス

マージリクエスト作成者は次のことを行う必要があります。

  • フロントエンドのイベントについては、関連する場合、使用したテストツールでのイベントのスクリーンショットを追加してください。
  • バックエンドのイベントについては、関連する場合、Snowplow Microgood eventsGET http://localhost:9090/micro/good の出力を追加してください（最初にGET http://localhost:9090/micro/reset でリセットするのが良いかもしれません）。
  • イベント辞書ガイドに従って、イベント定義ファイルを追加または更新します。

Analytics Instrumentationのレビュアーは以下のことを行ってください。

  • イベント スキーマが正しいことを確認します。
  • 推奨される使用方法を確認してください。
  • イベント辞書ガイドに従って、イベント定義ファイルが作成または更新されているか確認してください。
  • 必要に応じて、利用可能なテストツールのいずれかを使用して、イベントがローカルで発火していることを確認します。
  • MR を承認し、MR のラベルを~"analytics instrumentation::approved" に変更します。
  • snowplowイベントがRedisHLLイベントをミラーする場合、@mdrussellをタグ付けして、ペイロードがこの目的に使用可能かレビューしてください。