OpenAPITools/openapi-generator

Enhancement to the Crystal client generator

Open

#8.363 geöffnet am 7. Jan. 2021

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Java (7.516 Forks)batch import
Client: CrystalEnhancement: GeneralHacktoberfesthelp wanted

Repository-Metriken

Stars
 (26.243 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 9T 1h) (123 gemergte PRs in 30 T)

Beschreibung

Description

Here is a list of pending enhancements.

  • remove commented code: some code (ruby) was commented out. If confirmed these code do not need to be plotted to Crystal, we can safely remove it
  • add return type to the function signature
  • add auto-generated doc (api, model, readme)
  • add more tests (e.g. upload file filie)
  • better code format

If anyone wants to help, please reply to let us know and we can share some good starting points.

openapi-generator version

Latest master

Related issues/PRs

https://github.com/OpenAPITools/openapi-generator/pull/8304

Contributor Guide

Research-Richtung
Konzentrieren Sie sich auf das Crystal Client Generator Modul im openapi generator Codebasis. Finden Sie die Dateien mit auskommentiertem Ruby Code und entfernen Sie sie. Fügen Sie dann Rückgabetypen zu Funktionssignaturen im generierten Crystal Code hinzu. Folgen Sie dem vorhandenen Muster, um automatisch generierte Dokumentation hinzuzufügen. Schreiben Sie zusätzliche Tests, z. B. für Dateiupload. Verbessern Sie schließlich die Codeformatierung.
Tech Stack
java
Domain
apitooling
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
GitOpenAPI Specification
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70