crickets-and-comb/shared

Remove common noqas.

Open

#41 geöffnet am 25. März 2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Makefile (0 Forks)auto 404
bugenhancementhelp wanted

Repository-Metriken

Stars
 (2 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Throughout our codebases, we ignore some common linting errors that are raised due to a mismatch between our formatting tools and our linting tools. Examples include E712 and E203. As a result, we have # noqa: E712 for example spread all over, and we often need to add these noqas to new code.

We should remove the need for these noqas in one of two ways:

  1. Add the class of linting error to the shared config files (usually the flake8 file).
  2. Update our formatting tool to modify the code to meet the standard.
  3. We may no longer need them in the first place due to updates in the meantime, so try first just removing the noqa altogether.

We should then remove the noqas wherever they exist in consuming repos.

In some cases, we may want to always fail to force developers to intentionally seek a solution or ignore it.

Contributor Guide

Research-Richtung
Identifiziere alle `# noqa` Kommentare im Code, insbesondere solche, die sich auf E712 und E203 beziehen. Prüfe, ob die Linting Regel zur gemeinsamen flake8 Konfiguration hinzugefügt werden kann, um sie global zu ignorieren. Falls möglich, füge die Regel zur Konfiguration hinzu und entferne die noqa Kommentare. Alternativ stelle sicher, dass das Formatierungstool (z.B. Black) so konfiguriert ist, dass es Code erzeugt, der die Linting Anforderungen erfüllt. Teste durch Ausführen des Linters und der Formatierungstools. Falls nicht mehr benötigt, entferne einfach die noqa Kommentare und überprüfe, ob der Linter besteht.
Tech Stack
python
Domain
backenddeveloper experience
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70