OpenAPITools/openapi-generator

Enhancement to the Crystal client generator

Open

#8,363 opened on 2021年1月7日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Java (26,243 stars) (7,516 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.
Enhancement to the Crystal client generator · OpenAPITools/openapi-generator#8363 | Good First Issue