Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Gem docs are extremely lacking

オープン
  • 何か問題がありますか？
#119 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

@ess がすでに取り組んでいます。

2020年4月14日 から。

評価

この issue はまだ評価されていません。

説明

bug documentation

Here are a few documentation issues that have been highlighted specific to this gem:

  • The primary CLI app that customers use to interact with their Engine Yard assets now lives in this project, but there is not even a mention of that in the docs, let alone usage instructions
  • Aside from a few examples, there are no actual library usage instructions within the gem
  • There is almost zero actual library documentation (as one might find on https://rubydoc.info )
  • As @lucis-fluxum points out in #109 , the actual API docs listed at https://developer.engineyard.com are missing information and are generally inconsistent. That issue belongs to another project, but it directly impacts this project as well, so we are making note of this here
主要言語
Ruby
スター
4
フォーク
19
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

engineyard/core-client-rb のほかの issue

engineyard/core-client-rb の issue をすべて見る

似ている issue

Ruby の issue をもっと見る

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

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