krsty / fe3-assessment-1

๐Ÿ† Frontend 3 ยท 2017-2018 ยท Assessment 1 ยท Kirsty Sampson ยท ID2
https://krsty.github.io/fe3-assessment-1/index.html
0 stars 0 forks source link

The code comments are pretty good but it looks like you didnt write them #6

Open Razpudding opened 6 years ago

Razpudding commented 6 years ago

The purpose of the assignment was for YOU to describe in your own words how the code works. Now I have no idea if you understand the code. It's also hard for me to see which functionalities you've added. Please list them next time

krsty commented 6 years ago

I think I misunderstood that part, I used the comments that were already in the original, as well as adding my own. (By looking up what that line of code meant, and pasting it)

But I used them as a reminder for myself so I knew what was going on, so I didn't change it into my own words because I already understood them. But now I know to do that next time! :)

And I thought I had described the functionalities pretty well in my read.me, but it seems I have to be more specific.

Razpudding commented 6 years ago

Maybe you could use a 'changes' section in your readme where you list which changes you made in respect to the original work. Its not mandatory but I need some way to easily see what additions you've made.