Hide pretty name for webhook scanner rules

オープン 初心者向け
#16,566 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
63/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
django, python
領域
backend

調査の方向性

まず webhook scanner rule のモデルと Django admin の設定を見つけ、pretty_name が未設定のときにどのように表示されるかを確認します。scanner rules では、値がない場合にこのフィールドを admin で非表示にします。未設定の pretty_name がそこで表示されなくなり、設定済みの値は引き続き利用できれば完了です。issue にファイルやテストの指定はないため、まず関連する admin テストを特定します。

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

説明

needs:info

We introduced pretty_name a long time ago when:

  • people writing the rules weren't the people using the informations from the
    rules
  • not all rules had a description or even more information about what the rule
    is flagging
  • rule names were not normalized

With the scanner pipeline, all of these points aren't valid anymore because our
detection analysts are writing and using the rules, and more automation is (or
should) lead to less manual/human efforts anyway. All rules must have a
description and a ticket these days, so it's fine to keep the rule ID as-is
(which is now also normalized btw), since the description should explain what
the detection/finding is about.

There is no real good reason to keep pretty_name anymore, at least for the
scanners (and their rules) in the pipeline. This is confusing and inconsistent.

We should deprecate this field, and for that, we should hide it when it isn't
set in the django admin, as a first step towards removing it (in the far
future).

┆Issue is synchronized with this Jira Task

主要言語
Makefile
スター
133
フォーク
52
平均マージ
8日 20時間
マージ済み PR(30日)
4

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

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

mozilla/addons のほかの issue

mozilla/addons の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

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

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