Gem is misnamed causing additional work during implementation
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 28/100
- Issue 类型
- 重构
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- ruby
- 领域
- api, documentation
调研方向
从 stream-chat.gemspec、lib/stream-chat.rb 以及 README 的 Installation 和 Getting Started 部分开始。比较两种提议的命名路径，并在进行任何更改前与维护者确认兼容性和发布决策。完成的标准是，所选路径在 gemspec、require 入口、README 和未来的 release 计划中保持一致。
由索引模型根据 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
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 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 小时 新手友好度 62/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
Homebrew/homebrew-cask#293134 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
notch8/iiif_print#430 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
ActionText::Content#to_markdown: <br> in a table cell and empty <tr> produce malformed Markdown tables可能已有人在做 @azmi2409 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复