search

SE310-1 / W.A.K

W.A.K is a movie tracker web-app developed to simplify and enhance the movie-rating experience while making this process more fun and customisable.
MIT License
2 stars 12 forks source link

Add comments #62

Closed klam656 closed 1 year ago

klam656 commented 1 year ago

Since the last team have not documented their code very well, which make us have very hard time to read and understand their code. I decided to add more meaningful comment, mostly in Js. I hope this will help us interpret the code and the whole software product more.

klam656 commented 1 year ago

Hi Vishva, Thank you for your kind words! I'm glad to hear that the comments have been helpful in understanding the code. To address your question, yes, the comments in this PR are all that I had planned to add initially. However, I appreciate you pointing out that there could be other files that might benefit from additional comments.mI think other files are mostly related to fronted (React), so that it is really difficult to me to comment about it. I'm open to suggestions and would be happy to consider adding more comments where needed. Please feel free to share your thoughts on specific areas or files that you think could use further clarification.

vdav02 commented 1 year ago

Awesome, thanks for your response. I understand that your expertise may not be front-end, and that's totally okay. Thank you for clarifying - I'm thinking of some of the files such as the components like MovieCard. I'll talk to the relevant people focused on front-end in our group on the Discord server to see if they would be able to take a look. Happy to merge it now - thanks for your hard work!!