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

Gem docs are extremely lacking

Abierto
  • ¿Algo no está bien?
#119 0 comentarios 0 reacciones 1 asignado Ver en GitHub

@ess ya está trabajando en esto.

Desde el 14/4/2020.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

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
Lenguaje dominante
Ruby
Estrellas
4
Forks
19
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 engineyard/core-client-rb

Todos los issues de engineyard/core-client-rb

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.