Skip to content

Best practices and code style #74

@cuducos

Description

@cuducos

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!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions