Hide pretty name for webhook scanner rules

Abierto Apto para principiantes
#16,566 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
63/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
django, python
Área
backend

Línea de trabajo

Empieza por localizar el modelo de reglas del escáner de webhooks y su configuración de Django admin. Después, comprueba cómo se muestra pretty_name cuando no está definido. Oculta ese campo en el admin para las reglas del escáner cuando no tenga ningún valor. La tarea estará terminada cuando un pretty_name sin definir deje de mostrarse allí, mientras que los valores definidos sigan estando disponibles; el issue no indica archivos ni pruebas, así que primero identifica las pruebas relevantes del admin.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Makefile
Estrellas
133
Forks
52
Merge medio
8 d 20 h
PR fusionados (30 d)
4

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de mozilla/addons

Todos los issues de mozilla/addons

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.