SalamLang/Salam

Refactor identifiers to be more descriptive

Open

#1.206 geöffnet am 27. Juni 2026

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C (22 Forks)auto 404
ccode stylehacktoberfesthacktoberfest-acceptedhelp wanted

Repository-Metriken

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

Beschreibung

medium

Ignoring extremely common, short typos globally (such as nd for and, ot for to/of/or, notin for not in, abd for and/add, and clen for clean/len) significantly reduces the effectiveness of the spell checker. These are very common typing mistakes that are highly likely to occur in documentation, comments, or string literals.

Recommended Approaches:

  1. Refactor Identifiers: If these words are used as variable, function, or parameter names in the codebase (e.g., nd for node/index, ot for other, clen for length), consider renaming them to more descriptive names (e.g., node, other, length). This improves code readability and eliminates the need to ignore these typos.
  2. File-Specific Exclusions: If these words are part of third-party files or generated code, use the skip option in pyproject.toml to exclude those specific files or directories from codespell instead of ignoring the words globally.

Originally posted by @gemini-code-assist[bot] in https://github.com/SalamLang/Salam/pull/1205#discussion_r3485903556

Contributor Guide

Research-Richtung
Durchsuchen Sie die Codebasis nach Bezeichnern wie 'nd', 'ot', 'notin', 'abd', 'clen', die als Variablen , Funktions oder Parameternamen verwendet werden. Bewerten Sie jedes Vorkommen, um festzustellen, ob eine Umbenennung in einen aussagekräftigeren Namen wie 'node', 'other', 'not in', 'add', 'length' die Lesbarkeit verbessert, ohne die Funktionalität zu beeinträchtigen. Verwenden Sie 'git grep' oder eine IDE, um alle Vorkommen zu finden. Überprüfen Sie auch Dokumentation und Kommentare auf diese Muster.
Tech Stack
c
Domain
backendtooling
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
GitC
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50