carpentries-incubator / carpentries-incubator/python-intermediate-development

Common Issues, Fixes & Tips is not very accessible.

Abierto
#490 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
TeX
Estrellas
63
Forks
77
Merge medio
20 h 8 min
PR fusionados (30 d)
3

Descripción

Possibly relating to #470: The issues and fixes are a bit obscure thanks to being hidden away.
They are referred to where relevant, but e.g. [here](https://carpentries-incubator.github.io/python-intermediate-development/12-virtual-environments.html#making-sure-you-can-invoke-python) it's at the end of a wordy sentence.

It could potentially be foregrounded more by having the Prerequisite just be the "What you need to be able to do", followed by another large "Common Issues" callout that says (more concisely) "If [problem], check the Common Fixes page" and links to it. Shifting the description of the fix to the fixes section would save enough space that it wouldn't take any extra.

Guía de contribución

Abrir la guía de contribución

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.

Línea de trabajo

Comienza con la sección enlazada "Making sure you can invoke Python" y localiza las referencias existentes a las páginas Common Issues y Common Fixes. Revisa cómo se presentan las indicaciones sobre los requisitos previos y los problemas, y luego haz que los problemas comunes destaquen más mediante enlaces concisos; el trabajo estará terminado cuando los estudiantes puedan encontrar las soluciones sin tener que analizar una frase demasiado extensa.

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-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.