Feedback on WordPress Plugin Boilerplate Powered Readme

LappleApple / feedmereadmes

Free README editing+feedback to make your open source projects grow. See the README maturity model to help you keep going.

Creative Commons Attribution 4.0 International

1.13k stars 51 forks source link

Feedback on WordPress Plugin Boilerplate Powered Readme #44

Closed Mte90 closed 2 years ago

Mte90 commented 6 years ago

This is my project that is used from different people but I am not sure how much is easy to understand the readme. https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered

LappleApple commented 6 years ago

Hi @Mte90: Thanks for your submission. I'm going to suggest that you check out this template (https://github.com/zalando/zalando-howto-open-source/blob/master/READMEtemplate.md) and others shared in this project repo and restructure your README to follow it/the template you find most useful. Then ping back to say "I'm ready." How does that sound?

Mte90 commented 6 years ago

I made few improvements following that doc, but I hope to recheck again ASAP.

Mte90 commented 6 years ago

Improved more the readme, done :-) It is funny that I was already using many of the hints suggested, I am not after all a dev without experience in interesting Readme 😂