search

ZeroTwentyFifty / zero_twenty_fifty

Open Source Product Carbon Footprint exchange platform that is PACT Conformant.
https://www.zerotwentyfifty.com
4 stars 3 forks source link

Update the README file to reflect a more "modern" approach to README/Github SEO #37

Open JohnVonNeumann opened 3 weeks ago

JohnVonNeumann commented 3 weeks ago

The README's for ZTF projects have been a fairly consistent second thought, which needs to change. I have some rough drafts ready which need to be finalised.

Update:

What I'm looking for reflects something from the incredible repo from cal.com, whose README is here:

https://github.com/calcom/cal.com/blob/main/README.md

And this should also serve as some good insights which influenced the thought behind this ticket.

https://www.codemotion.com/magazine/dev-life/github-project/

tntruong-iter commented 3 weeks ago

Hi @JohnVonNeumann, could you please assign this issue to me? I'd like to work on it. Thanks!"

JohnVonNeumann commented 2 weeks ago

Hey @tntruong-iter thank you for reaching out, in terms of assigning the issue, I have had a few people express interest in this ticket, and so I have removed myself from the ticket itself but I will be leaving it open to whoever wishes to contribute. If you'd like to submit a patch I'd welcome it immensely. I also have a similar ticket on our other project here; https://github.com/ZeroTwentyFifty/pact_methodology/issues/35

I hope to see a PR soon, thank you for your interest!