openedx / openedx/code-annotations
Ensure only defined annotations are allowed
オープン
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 5
- フォーク
- 13
- 平均マージ
- 18時間 26分
- マージ済み PR(30日)
- 4
説明
At this time, users are not given any linting warnings when undefined annotations are used, including misspellings.
Additional Notes:
- An example: someone might use
toggle_warningsinstead oftoggle_warning. - It has been noted that removing the ability to comment between annotations (see https://github.com/openedx/code-annotations/issues/89) would make this simpler to implement.
- Linting might be implemented here: https://github.com/openedx/edx-lint/blob/7573005f89df7f78142a2af86673206e8b43c4d5/edx_lint/pylint/annotations_check.py#L291
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
既存の linting のエントリーポイントを理解するため、まず edx_lint/pylint/annotations_check.py の 291 行目付近を確認してください。アノテーション間のコメントについての issue #89 の議論を確認し、そのうえで、アノテーション名が未定義またはスペルミスの場合(toggle_warning ではなく toggle_warnings など)に警告を出力することを完了条件としてください。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- tooling
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100