Harmonize code conventions: naming syntax / jsdoc

resourcepool / rainstorm

Apache License 2.0

1 stars 1 forks source link

Harmonize code conventions: naming syntax / jsdoc #17

Open loicortola opened 8 years ago

loicortola commented 8 years ago

File names are either fileName or FileName and maybe should be considered being file-name... Documentation is non-consistent and incomplete Need precise code conventions described in a CONTRIBUTING.md file

Zacaria commented 8 years ago

I think that following airbnb guidelines are good point to start with.

I think that we should harmonize file names with that convention :

file name should match exported function
file name should be PascalCase if a class is exported
file name sould be camelCase otherwise

Should that be added to contrinuting.md or the reference to airbnb styleguide is enough ?