ryanmcdermott/clean-code-javascript

What about Magic strings?

Open

#122 geöffnet am 12. Jan. 2017

Auf GitHub ansehen
 (13 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (12.469 Forks)batch import
help wanted

Repository-Metriken

Stars
 (94.343 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Do you think that can be good to include something about magic strings?

Bad:

let posts = getPostsFromCategory('sports');

Good:

const categories = {
  sports: 'sports',
  economy: 'economy'
};

let posts = getPostsFromCategory(categories.sports);

Contributor Guide

Research-Richtung
Überprüfe die vorhandene Dokumentation im Repository (wahrscheinlich die README), um einen geeigneten Ort für einen Abschnitt über magische Zeichenketten zu finden. Prüfe die Issue Kommentare auf Anleitungen der Maintainer oder frühere Vorschläge. Füge den vorgeschlagenen Inhalt mit geeigneter Formatierung und Beispielen hinzu.
Tech Stack
javascript
Domain
documentation
Issue Type
Funktion
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.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaScript fundamentals
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80