OpenAPITools/openapi-generator

Enhancement to the Crystal client generator

Open

#8,363 建立於 2021年1月7日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Java (26,243 star) (7,516 fork)batch import
Client: CrystalEnhancement: GeneralHacktoberfesthelp wanted

描述

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

貢獻者指南

技術棧
無
領域
apibackendtooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Crystal language basicsOpenAPI Generator codebase navigation
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50
研究方向
Review the referenced PR #8304 for context. The issue lists concrete tasks: remove commented Ruby code, add return types, generate docs, add tests (e.g., upload file), and improve code formatting. Look at the Crystal client generator module in the openapi generator repo (likely under modules/openapi generator/src/main/resources/com/openapitools/codegen/crystal). Start by identifying the commented code and confirming removal, then proceed with adding type annotations and docs. Tests may be in the test directory. Check maintainer comments for starting points.