Usage Guide in readme and/or on rust docs page

Abierto
  • ¿Algo no está bien?
#2 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
rust
Área
documentation

Línea de trabajo

Comienza revisando el README y la página de documentación de Rust para identificar qué áreas de uso carecen de explicación. Añade una guía de uso que explique qué hacen los componentes del proyecto y considera si el contenido debe incluirse en el README, en la página de documentación de Rust o en ambos; se considera terminado cuando los usuarios pueden entender cómo usar la library.

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

Descripción

Would be nice to have. then it can have more explanation of what does what.

Lenguaje dominante
Rust
Estrellas
53
Forks
9
Merge medio
33 min
PR fusionados (30 d)
4

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 chatmail/yerpc

Todos los issues de chatmail/yerpc

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.