Closed thiamsantos closed 7 years ago
Hey @thiamsantos, thanks for these suggestions. I'm currently a bit busy due to my professional work that's why couldn't dedicate much time to this project at the moment. I'll soon be free, and planning to roll out v2.0.0
.
For the above suggestions, feel free to send a pr, if that improves the project in any way.
I really appreciate your efforts.
Thanks!
Thanks for the quick response @thinker3197
For the above suggestions, feel free to send a pr, if that improves the project in any way.
I will send it soon, but I just need some things from you.
First of, I'd like to say how awesome this project is. @thinker3197 thanks for publishing it :tada:. But, I have some suggestions that might improve the quality of the project.
Implement tests
Would be good to implement unit tests, and take that opportunity to separate the codebase into small modules (maybe using the ES6 modules syntax).
Code style
Follow a popular and battle tested code style like xo, standard or Airbnb. I personally prefer xo but they all are good options.
Readme
Would be great update the readme following the standard readme specification in order to provide a predictable format, helping the people to understand the purpose of the project and how to use it.
Contributing guidelines
Improve the present guidelines, maybe making something like this example.
Ignore files
Use some approach for npm ignore some files when publishing the package.
What do you think? For anyone of these ideas I would be happy on send a Pull Request :smile: