WordPress-Coding-Standards / eslint-config-wordpress

This package has been deprecated, please use @wordpress/eslint-plugin or @wordpress/scripts
https://www.npmjs.com/package/@wordpress/eslint-plugin
MIT License
45 stars 13 forks source link

Add Documentation for using the config #43

Closed swashata closed 6 years ago

swashata commented 6 years ago

The purpose of this is to add documentation which is beginner friendly to setup and use ESLint and eslint-config-wordpress for projects.

/cc @ntwb

swashata commented 6 years ago

@ntwb Please review and let me know if the folder structure is the right way to go. I will change things if needed.

swashata commented 6 years ago

@ntwb I am done with the docs. Please review.

ntwb commented 6 years ago

Apologies for the delay in reviewing this, I'll get stuck into it soon, there is much more here than I was expecting :)

swashata commented 6 years ago

@ntwb no issues at all... I am just investing my company time for three weeks of OSS stuff :) My goal is to learn new ES6, React and WordPress Gutenberg. I am happy to help anywhere I can.

ntwb commented 6 years ago

Thanks a bunch @swashata, I decided to merge this as is, there are a couple of minor tweaks but it will be easier for both of us to merge it as is and iterate from there

Thanks 😄

swashata commented 6 years ago

Great. Thank you. Do let me know if you need me to edit something.