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

Best practices and code style #74

Open
cuducos opened this issue Jul 21, 2017 · 1 comment
Open

Best practices and code style #74

cuducos opened this issue Jul 21, 2017 · 1 comment

Comments

@cuducos
Copy link
Contributor

cuducos commented Jul 21, 2017

As suggested in #71:

I would like to suggest a minimum contribution guide with our agreement on code stye and best practices for this project.

Long story short my suggestions would be:

  • ES6 compliant
  • any consolidate code style guide
  • something like Browserify and Babel to generate the browser/CDN .min.js (haven't checked the current gulpfile.js but maybe it's already there)

By consolidated I mean anything compatible with JSLlint. IMHO in spite f the semicolons I'd go with Airbnb.

What do you think about it? Here is how I plan to review this PR:

  1. we could agree on something among these lines in terms of best practices and code style
  2. we add that to README.md (or create CONTRIBUTING.md if it gets too long once again)
  3. finally I'll have stuff other than my own opinion to dive into code

Hey @flaviosilveira, jump in!

@nandomoreirame
Copy link
Collaborator

nandomoreirame commented Jul 22, 2017

Hey, @cuducos welcome back bro! 🤘

Yes! I approve your all suggestions and complement the check list:

  • ES6 compliant ~> Maybe rewrite code with a version 2.0 using ES6
  • Any consolidate code style guide ~> If rewrite core using ES6 we can use Browserify and Babel
  • Any consolidate code style guide ~> If rewrite core using ES6 we can use Airbnb JavaScript Style Guide
  • If we rewrite the core, I chose ESLint from JSLint
  • And also... We can change the Gulp to Webpack or Browserify for automatization the tasks :)

As for this Pull Request (#71), I think it's just to remove prototype files and implement some things from ES6 in GulpJS files...

We can continue this discussion for new projects ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants