OpenAPITools/openapi-generator

Enhancement to the Crystal client generator

Open

#8363 aperta il 7 gen 2021

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Java (7516 fork)batch import
Client: CrystalEnhancement: GeneralHacktoberfesthelp wanted

Metriche repository

Star
 (26.243 star)
Metriche merge PR
 (Merge medio 12g 6h) (104 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Rivedi il PR #8304 citato per il contesto. Il problema elenca compiti concreti: rimuovere il codice Ruby commentato, aggiungere tipi di ritorno, generare documentazione, aggiungere test (ad esempio, caricamento file) e migliorare la formattazione del codice. Esamina il modulo generatore client Crystal nel repository openapi generator (probabilmente in modules/openapi generator/src/main/resources/com/openapitools/codegen/crystal). Inizia identificando il codice commentato e confermandone la rimozione, poi procedi con l'aggiunta di annotazioni di tipo e documentazione. I test potrebbero essere nella directory test. Controlla i commenti del manutentore per i punti di partenza.
Tech stack
Nessuno
Dominio
apibackendtooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Crystal language basicsOpenAPI Generator codebase navigation
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50