DOC: update contributing guide to reflect the preferred practice
Offen
Dieses Issue hat noch niemand übernommen.
documentation
infrastructure
- Vorherrschende Sprache
- Keine Sprachdaten
- Sterne
- 673
- Forks
- 229
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Currently missing points:
- No outputs should be included in the notebooks
- we do prefer
.mdfiles as opposed to.ipynb.
Maybe the updated guide should be in a separate file, and keep the absolute newcomer version, that we currently have, in the README?
Beitragsleitfaden
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
Lies den aktuellen Beitragsleitfaden und die README, um zu sehen, wo die Praktiken für Notebooks dokumentiert sind. Aktualisiere die Hinweise dahingehend, dass Notebooks keine Ausgaben enthalten sollten und dass .md-Dateien gegenüber .ipynb bevorzugt werden; als erledigt gilt die Aufgabe, wenn die gewählte Struktur des Leitfadens beide Punkte klar widerspiegelt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100