SpinalHDL/SpinalHDL

Rename OKEY -> OKAY

Offen

#932 geöffnet am 24.10.2022

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Scala (373 Forks)batch import
api :art:code quality :recycle:good first issue

Repository-Metriken

Stars
 (1.986 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 6T 9h) (5 gemergte PRs in 30 T)

Beschreibung

This is a typo in the API XD

What to choose? OK or long version OKAY?

  • Chose OKAY
  • Find all occurrences of /OKEY/ (as pattern, not as a full word because eg. setOKEY must be a match too)
  • Let the previous items as @deprecated("Typo, use XXX instead"), do not remove them
  • Add new items with correct spelling

Contributor Guide

Research-Richtung
Durchsuche die Codebasis nach allen Vorkommen von 'OKEY' (Groß /Kleinschreibung beachten) und ersetze sie durch 'OKAY'. Füge den alten Symbolen eine Deprecation Anmerkung hinzu, die auf die neuen verweist.
Tech Stack
scala
Domain
devtools
Issue Type
Wartung
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
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.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitScala
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
95