Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Gem is misnamed causing additional work during implementation

Abierto
#114 3 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
28/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
ruby
Área
api, documentation

Línea de trabajo

Comienza con stream-chat.gemspec, lib/stream-chat.rb y las secciones Installation y Getting Started de la README. Compara las dos rutas de nomenclatura propuestas y confirma la decisión sobre la compatibilidad y la publicación con los maintainers antes de cambiar nada. Se considera terminado cuando la ruta seleccionada es coherente en el gemspec, el punto de entrada require, la README y el futuro plan de release.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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:
  1. Change the name in the gemspec file to stream-chat
  2. Update the README to use the new name in the Installation section, and remove the require call in the Getting Started section
  3. 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:
  1. Add a file named lib/stream-chat-ruby.rb which calls require "stream-chat"
  2. Update the README to remove the require call in the Getting Started section
Lenguaje dominante
Ruby
Estrellas
32
Forks
23
Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de GetStream/stream-chat-ruby

Todos los issues de GetStream/stream-chat-ruby

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.