Simulation-Software-Engineering / Simulation-Software-Engineering/Lecture-Material
Suggestion for Per Chapter Readme
Aperta
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 63
- Fork
- 70
- Merge medio
- 8g 18h
- PR unite (30g)
- 1
Descrizione
Currently the content in per chapter Readme is not in a flow.
Example:
It would be nice to make it in a better flow like:
I would be happy to create a PR for it. Thanks.
gitlab id: dardama
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
Individua i file README dei singoli capitoli e confronta l’ordine attuale dei relativi contenuti con le due immagini di esempio nell’issue. Il lavoro è completato quando i README interessati seguono un flusso più chiaro e coerente e il contenuto visualizzato corrisponde alla disposizione prevista.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 38/100