carpentries-incubator / carpentries-incubator/python-intermediate-development

Improvements to Section 4 from UKAEA experience

Aperta
#378 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
ukaea-rse-team
Lingua principale
TeX
Stelle
63
Fork
77
Merge medio
20h 8m
PR unite (30g)
3

Descrizione

The following comments were left by @hsaunders1904 following his delivery of Section 4

- In one of the exercises, pupils are asked to resolve comments made by their partners on a PR. The exercise says that if there isn't time to resolve a comment, they should open an issue and link back to the comment. Many of the pupils didn't seem to know what an issue was, and issues are disabled on forked GitHub repositories by default. So there was a decent chunk of time a) explaining what an issue was, b) showing how to enable issues (after working it out ourselves) and c) showing how to open one, which I think was out of the scope of this section and is covered in section 5.

While the advice in the exercise is obviously good advice, it did lead the class down a bit of a rabbit-hole. I'm not aware of any students that actually ended up opening an issue at this point.

- In the 'Empathy in review comments' slide, one of the bullet points says:

> 'Only provide a few non-critical suggestions - you are aiming for better rather than perfect'

Which I don't really agree with. I don't think pupils should go away feeling like the number of comments they make on a PR should be limited. They should make as many comments as they feel are appropriate; particularly if the PR is on the larger side. I took this bullet-point out when delivering the course.

- In the 'Code Review in Your Own Working Environment' exercise, I didn't get any feedback/conversation at the end. This may well just have been due to the way I delivered it, but for instructors delivering this section in the future: it may be useful to talk through an example process, or write some questions at the beginning of the session that will be asked at the end. I think this might help with engagement.

- I felt the break time was misplaced in the slides. We broke after the code review section (which had lots of time-consuming exercises), then got through the reuse and packaging sections (which were less exercise heavy) after the break.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Individua i file sorgente e delle slide della lezione di Section 4, quindi esamina l’esercizio sulla risoluzione dei commenti nelle PR, la slide “Empathy in review comments”, l’esercizio di code review e la collocazione della pausa. Confrontali con il feedback di questa issue e aggiorna i materiali della lezione in modo che le indicazioni, i suggerimenti per l’istruttore e il programma riflettano l’esperienza di svolgimento riportata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
tex
Ambito
content, documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.