Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Proposal] switch to camelCase for function and variable names #72

Closed
aganov opened this issue Nov 14, 2017 · 3 comments
Closed

[Proposal] switch to camelCase for function and variable names #72

aganov opened this issue Nov 14, 2017 · 3 comments

Comments

@aganov
Copy link

aganov commented Nov 14, 2017

Hello. Thanks for the great library. One thing that bothers me is that most of the code is written with underscore style which is not so widely adopted code style in the JS world. Can you consider moving to cameCase for function and variable names? Also, it will be good idea to set up eslint with some community adopted style guide such as Airbnb JavaScript Style Guide. Thanks.

@pratu16x7
Copy link
Contributor

pratu16x7 commented Nov 15, 2017

@aganov Thanks for the feedback! We appreciate your concern over code standards :)

I do agree that the style used in non-standard in JavaScript, and it sure is a possible reason that may make using it difficult. This project was actually an outcome of something we ourselves needed in our product, which had a different code style. Seeing that it was easy to use, we worked the best we could to release it as a potential library; unfortunately amongst planning out the arch and builds, changing the style didn't gain as much priority. There are quite a few things missing that'd make it a perfect library (tests, docs ...), and during these initial stages, we are working on getting them done :)

Even so, changing names is a straightforward change if planned, given the small code base; and we'd sure appreciate help :) (the utils would be good place to start). However, it would be great if contributors would let us know before embarking on a task (this applies to any contribution), in case we are working on something at the moment.

@pratu16x7
Copy link
Contributor

Some progress, utils are out of the way. The main code base will be after refactoring.

@pratu16x7
Copy link
Contributor

The code base just went through a rewrite, with the release of v1. A style guide would surely be the next step, contribution guidelines are on the way. Thanks for the review :)

@pratu16x7 pratu16x7 mentioned this issue Apr 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants