feedmereadmes icon indicating copy to clipboard operation
feedmereadmes copied to clipboard

Published 20 hours ago • verified publisher icon LappleApple

Feedback on WordPress Plugin Boilerplate Powered Readme

Open Mte90 opened this issue 7 years ago • 3 comments

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

Mte90 avatar Oct 30 '17 14:10 Mte90

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?

lasomethingsomething avatar Oct 31 '17 12:10 lasomethingsomething

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

Mte90 avatar Oct 31 '17 22:10 Mte90

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 😂

Mte90 avatar Nov 02 '17 13:11 Mte90