search

hongjoyce / ColorPaletteProject_OpenAI

1 stars 0 forks source link

ฅ^•ﻌ•^ฅ #1

Open raebeb opened 9 months ago

raebeb commented 9 months ago

Hi Hong! I loved this, I really liked the idea and I think you should keep working on this and deploy it, I think its really useful for those who work making logos for companies or things like that, personally I like to knit and Im always checking those websites that tell you what colors go well together, so your project will be very useful for me Here are some recommendations:

  1. you can create a .env.example file with the initial template to avoid mistakes, like this repo https://github.com/platformsh-templates/laravel/blob/master/.env.example so I can just delete the '.example' of the name or create a copy and just put my values
  2. I really like documentation, so I would improve the readme, because it took me some time to figure it out how to start the app, there are a lot of readme templates, you can use this one as an example https://github.com/raebeb/manga_scraper/blob/main/README.md
  3. Im not sure if I talked to you about pep8, if not this is a good moment to start learning about it, basically it is to write nice and understandable code for other programmers following good practices https://peps.python.org/pep-0008/
  4. for comments inside your code, use docstrings (these are explained in the pep8 doc) and you can use this library to generate automatically https://gpt4docstrings.readthedocs.io/en/latest/

keep working on this, I want to see it deployed 🙌🏻

hongjoyce commented 9 months ago

Hi Fran,

Your recommendations are really impressive! They are all very critical points. Thank you so much for being proactive and providing solutions. creating an .env.example is a great idea. I did not know I could do these! You expanded my knowledge again! You are so right, the current readme is super unsophisticated. Definitely have to provide a polished version. Yes, my goal is to write the pep8 style code. Thanks again for all the suggestions! i will definitely try my best to make it an exhaustive project :)!

Hong

On Wed, Dec 6, 2023 at 10:26 AM Fran @.***> wrote:

Hi Hong! I loved this, I really liked the idea and I think you should keep working on this and deploy it, I think its really useful for those who work making logos for companies or things like that, personally I like to knit and Im always checking those websites that tell you what colors go well together, so your project will be very useful for me Here are some recommendations:

  1. you can create a .env.example file with the initial template to avoid mistakes, like this repo https://github.com/platformsh-templates/laravel/blob/master/.env.example so I can just delete the '.example' of the name or create a copy and just put my values
  2. I really like documentation, so I would improve the readme, because it took me some time to figure it out how to start the app, there are a lot of readme templates, you can use this one as an example https://github.com/raebeb/manga_scraper/blob/main/README.md
  3. Im not sure if I talked to you about pep8, if not this is a good moment to start learning about it, basically it is to write nice and understandable code for other programmers following good practices https://peps.python.org/pep-0008/
  4. for comments inside your code, use docstrings (these are explained in the pep8 doc) and you can use this library to generate automatically https://gpt4docstrings.readthedocs.io/en/latest/

keep working on this, I want to see it deployed 🙌🏻

— Reply to this email directly, view it on GitHub https://github.com/hongjoyce/ColorPaletteProject_OpenAI/issues/1, or unsubscribe https://github.com/notifications/unsubscribe-auth/AXPAYA2Q3EWY5PF5INSAEHTYICFBDAVCNFSM6AAAAABAJR6QNSVHI2DSMVQWIX3LMV43ASLTON2WKOZSGAZDQOBQGU2TMNI . You are receiving this because you are subscribed to this thread.Message ID: @.***>