Gem is misnamed causing additional work during implementation
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 28/100
- issue の種類
- リファクタリング
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- ruby
- 領域
- api, documentation
調査の方向性
stream-chat.gemspec、lib/stream-chat.rb、README の Installation および Getting Started セクションから始めます。提案されている 2 つの命名方針を比較し、何かを変更する前に、互換性と公開に関する判断をメンテナーと確認します。完了の条件は、選択した方針が gemspec、require エントリーポイント、README、今後のリリース計画で一貫していることです。
索引モデルが issue の本文から書いたものです。
説明
The main file in this gem is lib/stream-chat.rb. The gemspec is named stream-chat.gemspec.
The "-ruby" part of the name is redundant in a Ruby gem name. With all that in mind, the gem should have been published under the name stream-chat. That name is not in use in Rubygems, so that is currently possible.
By not having the name of the gem not matching the name of the main file, the additional step of calling `require "stream-chat" is necessary. That's not standard or expected in the Ruby world, it would only be expected if the gem has files that should only be included under limited and specific conditions, like test harnesses.
So here are two possible paths to improve this:
Change the name of the gem:
- Change the name in the gemspec file to
stream-chat - Update the README to use the new name in the Installation section, and remove the
requirecall in the Getting Started section - Publish new versions to rubygems under the new name (and potentially also the old name)
Downside of simply renaming the gem going forward is that those using the gem under the old name would no longer receive new versions of the gem, unless it's published under both names going forward.
Remove the need for an additional require call:
- Add a file named
lib/stream-chat-ruby.rbwhich callsrequire "stream-chat" - Update the README to remove the
requirecall in the Getting Started section
- 主要言語
- Ruby
- スター
- 32
- フォーク
- 23
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
GetStream/stream-chat-ruby のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
GetStream/stream-chat-ruby#215 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
GetStream/stream-chat-ruby#137 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
GetStream/stream-chat-ruby#133 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
GetStream/stream-chat-ruby#132 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
GetStream/stream-chat-ruby#127 ·
GetStream/stream-chat-ruby の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
googleapis/google-api-ruby-client#28001 · リアクション 5 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100