OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks

Update READMEs

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

Nadie ha tomado este issue todavía.

Lenguaje dominante
Jupyter Notebook
Estrellas
70
Forks
15
Merge medio
10 h 42 min
PR fusionados (30 d)
2

Descripción

The main readme needs to be updated, and we need secondary readmes to explain why a notebook exists (in addition to explanation in the notebook itself).

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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

Empieza por el README principal y los archivos README secundarios existentes junto a los notebooks. Actualiza el README principal y asegúrate de que cada README secundario explique por qué existe su notebook. El trabajo estará terminado cuando estén documentados tanto el resumen general como los propósitos específicos de cada notebook.

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

Evaluación

Stack tecnológico
jupyter-notebook
Área
documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
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.