Improve documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 50/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- ruby
- Área
- documentation
Línea de trabajo
Comienza con los ejemplos de README.md y compáralos con la documentación completa de la página de Rubydoc enlazada para Harvesting::Client#clients. Actualiza el README para dirigir a los lectores a esa documentación y, después, verifica que el enlace y las indicaciones que lo rodean sean claros.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
I realize that examples in the README.md are not the best way to document the behavior of this gem.
It would be great if we could point people to this page so that they could see complete documentation of the librtary: https://www.rubydoc.info/github/ombulabs/harvesting/Harvesting/Client#clients-instance_method
- Lenguaje dominante
- Ruby
- Estrellas
- 29
- Forks
- 30
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una plantilla de pull request
- Sin guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de fastruby/harvesting
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
fastruby/harvesting#69 ·
-
Line Item ModelsAbiertoFeature Request
Dificultad 3/5 1-2 días Aptitud para principiantes 25/100
fastruby/harvesting#36 · 5 comentarios ·
-
Feature Request
Dificultad 4/5 3-5 días Aptitud para principiantes 38/100
fastruby/harvesting#12 · 4 comentarios ·
Todos los issues de fastruby/harvesting
Issues similares
-
Local evaluation buckets percentage splits with the server key, so results differ from FlagsmithAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Add PrestashopAbiertorequest
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
endoflife-date/endoflife.date#11303 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
FreeTubeApp/FreeTube-Docs#245 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día