search

Balve-user / garmeres_v3

https://garmeres-v2.vercel.app
0 stars 1 forks source link

Readme improvement #166

Open mashazyu opened 2 weeks ago

mashazyu commented 2 weeks ago

First of all, currently info in readme is very thorough and I was able to start contributing immediately. Thank you very much for that!

Based on conversation in #161

  1. I didn't have to add any additional data in the local .env to have website up and running locally. My proposal is to
    • remove "Populate the variable called SANITY_API_READ_TOKEN with the token received from the previous step. You should be able to leave the rest of it blank for now." statement from readme.
    • add .env.example to the repo with the necessary variables
  2. It wasn't clear for me from the readme that I had to fork the repo. I'd like to add this step.
  3. Maybe move contribution section to the separate file?
  4. Also, maybe add info, whom to contact if one wants to pick up the issue? And add list maintaners? I tagged @leevi978, just because the issue I wanted to work on was created by them. But may there are other people I can ask questions to?

What do you think about these changes?

leevi978 commented 2 weeks ago

@mashazyu These are all great suggestions, and I agree to all of them. So far it has just been me working on this repo, so the README has not been tested before you did, and so I have not been given feedback on what is missing.

Did you want to make the change for the readme? I'd be happy to, but then it will not happen for a few weeks at least

mashazyu commented 1 week ago

@leevi978 Thank you for the positive feedback! Something came up and I wasn't able to work on it, but will be happy to propose changes early next week, if that's ok.

leevi978 commented 4 days ago

@mashazyu That is very ok, and I really appreciate your contributions!