codrsquad / codrsquad/portable-python
Request: More detailed documentation about the configuration file
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 86
- Forks
- 13
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
This repository has a very high code quality and very decent output.
I notice this portable-python package is quite configurable, but I can't find any documentation about it, and have to read the source code and test cases. It is not very efficient and a little painful.
Is that possible to add more documentation about portable-python.yaml?
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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.
Línea de trabajo
Comienza revisando el código fuente y los casos de prueba que definen portable-python.yaml, y luego documenta las opciones de configuración disponibles y su uso. El trabajo estará terminado cuando los usuarios puedan entender y configurar el paquete sin tener que inspeccionar el código fuente ni las pruebas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100