search

michelgrootjans / playing_with_projections

Preparation of a workshop
22 stars 50 forks source link

Improvment suggestions #40

Open loicknuchel opened 7 years ago

loicknuchel commented 7 years ago

Hi, again, thanks a lot for your workshop, I really enjoyed it and played with it all the weekend (didn't try advanced challenges until now but it will come...).

Here are some improvment suggestions that came in my mind :

  1. write instructions in the README.md or in an instructions.md inside the repo so we don't have to browse wiki to see them and they will be in a fork (wiki is not forked)...
  2. there is a lot of data files and I don't really know how to use them. Maybe two are enough : one with minimal data to investigate errors by hand and one with a lot of data to run the projection challenges and check results
  3. you provided a sheet with event examples, it could be in a events.json instead of a pdf (copy/paste, ide integration ...)
  4. you also draw the event workflow on the board, it could be cool to have it (as an image or pdf) inside the repo
  5. when I develop a projection, I don't know if it's correct or not. Providing expected results would help to know if I'm done with it or not. Maybe some tests would be great too...
  6. add more guidance in the instructions/code, for exemple, add empty functions to fill instead of blank page...
  7. and, last but not least, I would be great to have some solutions (on a separate branch for example) and maybe different implementation samples for the same challenge... (for exemple, here are my solutions in JS: https://github.com/loicknuchel/playing_with_projections/tree/add-js-solutions/js/solutions)

Again, you did a very great job, thank you guys :D

tcoopman commented 7 years ago

Thanks for the great feedback, some quick answers:

The last 3 is something we have been thinking of and not really implemented something yet, we don't want to provide too much guidance because that pushes you in some direction and it's a lot of work to keep all the implementations in the different languages in sync, but I also agree we could improve this.

@michelgrootjans what are your ideas on this?

loicknuchel commented 7 years ago

Yeah, providing a lot of languages adds a lot of work... I probably can do a pull-request to improve JS in this way so we could discuss about this more concretly.

For the instructions, I think markdown file is really great :) For the flow picture, I just saw it ! Awesome !