OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
Update READMEs
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 70
- Forks
- 15
- Ø Merge
- 10 Std. 42 Min.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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).
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der主README und den vorhandenen sekundären README-Dateien neben den Notebooks. Aktualisiere die主README und stelle sicher, dass jede sekundäre README erklärt, warum ihr Notebook existiert. Die Arbeit ist abgeschlossen, wenn sowohl der Überblick als auch die notebook-spezifischen Zwecke dokumentiert sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- jupyter-notebook
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100