openedx / openedx/code-annotations

Annotations for tracking log statements

オープン
#180 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Python
スター
5
フォーク
13
平均マージ
18時間 26分
マージ済み PR(30日)
4

説明

We should add annotations for both Python and Javascript tracking log statements so that we can generate reports between releases to document which events have been added / removed / changed, where they are being emitted from, and confirm that those changes do not break downstream reporting.

We should at least include the event name and description thought it would be ideal to capture the fields, types, and descriptions so that we can automatically create documentation like we have been doing manually:
https://docs.openedx.org/en/latest/developers/references/internal_data_formats/tracking_logs/student_event_types.html

This would involve:

  • Adding a new config type for tracking events
  • Adding a new Sphinx extension to render the documentation
  • Updating docs.openedx.org to use the new documentation to replace the event reference
  • Creating a tool to generate reports across repositories in the openedx org

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

code_annotations/contrib/config にある既存の設定型と、code_annotations/contrib/sphinx/extensions にある Sphinx 拡張から始めます。イベント名、説明、フィールド、型、説明に対するアノテーション要件を定義し、リンクされたイベントリファレンスのドキュメントを確認して、リポジトリ横断のレポートツールを計画します。生成されたドキュメントとリリースレポートで現在の手動のイベントリファレンスを置き換えられれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript, python
領域
documentation, tooling
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。