Improve Klondike tutorial

Aperta
  • Qualcosa non va?
#2,917 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
dart, flutter
Ambito
documentation

Direzione di ricerca

Individua il Klondike tutorial e rivedi le parti 4, Gameplay, e 5, Additional features, confrontandole con il codice completo mostrato alla fine di ciascuna parte. Verifica dove le istruzioni, i pulsanti Run e Code e gli avvisi non sono chiari; il lavoro è completato quando il tutorial può essere seguito con confini tra i passaggi più chiari e risultati funzionanti.

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

Descrizione

enhancement

What could be improved

Feedback on the Klondike tutorial from moluderu on Discord:

I tried to compile my feedback on the tutorial I nearly finished. It took me about 12-15 hours, I didn't really count.
Right now, if I follow the tutorial exactly as it's written, I end up with an application that doesn't work at all. It's missing pieces and it's full of errors. With the full code at the end of each part, I was able to improve my code to bring it up to standard, but it's essential to do so and this button isn't really highlighted in the tutorial. I think it would be a good idea to use the "Run" and "Code" buttons more often throughout the tutorial.
If you do as I do, you'll end up with clean, functional code after all.
A few small warnings about deprecated stuff like "event.delta" or ".forEach" but, on the whole, it works well.
Overall, the tutorial would benefit from being more injunctive: being clearer about "you MUST do this" or "it's ALREADY been done".
To be a little more precise, I'd have to say it's well written, but there are a few areas that need a bit of work.

In part 4.Gameplay, there's a lack of detail, but it's an advanced stage of the tutorial, so it's not a problem - it just helps to see if you've followed the instructions correctly.
On the other hand, in the last part, 5.Additionnal features, there are quite a few things that are difficult to follow with the large blocks of text and code. The author seems to assume that we have the complete code in front of us at the same time and can directly see what he has written. But the complete code is at the very end of the page and I have to say that I'd rather do things myself than read code comments. This part gave me trouble and I find the rest of the tutorial much better. Sorry for the author, I don't mean to be rude, I'm trying to give constructive criticism.
I've got as far as the "A New World" part for now and it's getting really difficult for me to continue. I'm finding it hard to move on at the moment, I don't seem to understand anything any more. I think I'll go through the documentation a bit and try a few things for fun before coming back to this.

Why should this be improved

To make it an easier time for our users to learn Flame.

Any risks?

No.

More information

Lingua principale
Dart
Stelle
10.8k
Fork
1.1k
Merge medio
1g 21h
PR unite (30g)
53

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di flame-engine/flame

Tutte le issue di flame-engine/flame

Issue simili

Altre issue su Dart

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.