Book: Section on config-description
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 20/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- rust
- Área
- cli, documentation
Línea de trabajo
Empieza leyendo la discusión en el pull request #166, especialmente el comentario referenciado, y revisa el uso propuesto de la crate type_description. El issue describe un concepto amplio de descripción de configuración legible por máquinas, en lugar de nombrar archivos o pruebas. Para obtener un resultado claro sería necesario acordar el alcance y el enfoque antes de poder comenzar la implementación.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
As requested in https://github.com/rust-cli/book/pull/166#discussion_r972045274 I'd like to open up a discussion about config description.
The general idea of what I call "config description" here is that a given configuration type can describe itself in a machine-readable way, which can ultimatively be rendered to user-documentation.
A user would ask the program "tell me how I can configure you?" and the program is then able to tell the user "I get configured via the following settings: 'greeting_message', which has to be a String, 'repeat', which has to be a number greater than zero".
A possible solution for this is sketched out in #166 using the type_description crate.
- Lenguaje dominante
- Rust
- Estrellas
- 1.1k
- Forks
- 122
- Métricas de merge de PR
- 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
- 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 rust-cli/book
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
-
Broken Discord linkAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 35/100
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 35/100
-
bug
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
Todos los issues de rust-cli/book
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
storytold/photocraft#5260 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
extendr/extendr.github.io#134 ·
-
awaiting-response bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
wildcard/caro#1655 · 1 comentario ·
Los mantenedores suelen responder en 1 día