Luke-Fanguna / FoodForLesser

0 stars 0 forks source link

Code Review Comments (Wesley Tam) #31

Open wesleytam88 opened 10 months ago

wesleytam88 commented 10 months ago
  1. Remove barrels.py, catalog.py, and other unnecessary files
  2. Use more useful commit messages instead of “should work” and “hey”
  3. Use doc strings to give methods brief descriptions and make them more understandable
  4. Standardize code indenting; different files indent very differently making it harder to read
  5. In store.py “find_best_item” function, implement a better way to disqualify an item based on price
  6. Add more comments within the code (ex. In list.py) to make it more understandable
  7. The demo key in auth.py can be used, consider removing this from your code
  8. Change the “get_bottle_plan” method name in crowdsourcing.py to something more relevant
  9. The store endpoints have the lists prefix, meaning they are categorized with the lists endpoints instead of being their own category
  10. In “upload_entry” in crowdsourcing.py, the created_at attribute can be auto-generated instead of being manually inserted
  11. Look into splitting the “distribute_list” and “find_best_item” into smaller/simpler functions to make it more readable
  12. Change the “set_item_quantity” function name to something else like “add_item” to make it clear the function inserts a new item into a list