JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Incorrect Namespace for the gem

Offen
#805 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Type: Maintenance
Vorherrschende Sprache
Ruby
Sterne
2.3k
Forks
546
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Regarding conventions this gem should be wrapped to

module JsonapiResources
end

Instead we have

module JSONAPI
end

I am pretty sure it was simplified specially to have more elegant code. But this decision was potentially dangerous. Now we have other young ruby gem https://github.com/beauby/jsonapi to simplify json parsing. it has same namespace that is correct and follows conventions. Unfortunately I could not use both gems at the same time, because instead of JSONAPI::Resource loading from jsonapi gem it loads code from jsonapi-resources gem. Super bad and blocker for me.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Die Aufgabe besteht darin, den JSONAPI-Namespace des Gems durch JsonapiResources zu ersetzen, um eine Kollision mit dem jsonapi-Gem zu vermeiden. Beginne mit einer Prüfung der öffentlichen JSONAPI-Referenzen und der Auswirkungen auf die Kompatibilität; abgeschlossen ist die Aufgabe, wenn beide Gems gemeinsam verwendet werden können, ohne das unterstützte Verhalten zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rails, ruby
Bereich
backend
Issue-Typ
Refactoring
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.