DOC: update contributing guide to reflect the preferred practice
Aperta
Nessuno ha ancora preso questa issue.
documentation
infrastructure
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 673
- Fork
- 229
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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?
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Leggi l’attuale guida per i contributi e il README per vedere dove sono documentate le pratiche relative ai notebook. Aggiorna le indicazioni specificando che i notebook non devono contenere output e che i file .md sono preferiti rispetto a .ipynb; il lavoro sarà considerato completato quando la struttura della guida scelta rifletterà chiaramente entrambi i punti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100