OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
Update READMEs
Ouverte
Personne n'a encore pris cette issue.
- Langage dominant
- Jupyter Notebook
- Étoiles
- 70
- Forks
- 15
- Merge moyen
- 10 h 42 min
- PR mergées (30 j)
- 2
Description
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).
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par le README principal et les fichiers README secondaires existants à côté des notebooks. Mettez à jour le README principal et veillez à ce que chaque README secondaire explique pourquoi son notebook existe. Le travail sera terminé lorsque la vue d’ensemble et les objectifs propres à chaque notebook seront documentés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- jupyter-notebook
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100