Improve Documentation

オープン
#399 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
25/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
openapi, ruby
領域
api, documentation

調査の方向性

The issue names no files, classes or methods, so first ask the maintainer which public APIs and configuration options should be covered. Then read the README and the gem's public entry points to find what is currently undocumented. Done means each chosen public API and option has a documented usage example that a newcomer can follow.

索引モデルが issue の本文から書いたものです。

説明

enhancement help wanted

There are quite a few ways to use this library and options to configure. I need some help to document the public APIs.

主要言語
Ruby
スター
222
フォーク
27
平均マージ
17時間 15分
マージ済み PR(30日)
6

環境構築

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ahx/openapi_first のほかの issue

ahx/openapi_first の issue をすべて見る

似ている issue

Ruby の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。