crickets-and-comb/shared

Remove common noqas.

Open

#41 ouverte le 25 mars 2025

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Makefile (0 forks)auto 404
bugenhancementhelp wanted

Métriques du dépôt

Stars
 (2 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Identifiez tous les commentaires `# noqa` dans le code, en particulier ceux liés à E712 et E203. Vérifiez si la règle de linting peut être ajoutée au fichier de configuration partagé de flake8 pour l'ignorer globalement. Si possible, ajoutez la règle à la configuration et supprimez les commentaires noqa. Sinon, assurez vous que l'outil de formatage (ex: Black) est configuré pour produire un code conforme au linting. Testez en exécutant le linter et les outils de formatage. Si plus nécessaires, supprimez simplement les commentaires noqa et vérifiez que le linter passe.
Stack technique
python
Domaine
backenddeveloper experience
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70