+- Aria Templates Forums (http://ariatemplates.com/forum)
+-- Forum: Public forums (/forumdisplay.php?fid=3)
+--- Forum: Hashspace (/forumdisplay.php?fid=14)
Because I skimmed through the sources and noticed quite a few different "styles" being applied.
For example the file naming is inconsistent: sometimes camelCase, sometimes not. See for example "hsp/compiler/treeWalker.js" vs "hsp/rt/exphandler.js".
Variable naming and function naming seems also to be inconsistent in some areas. Sometimes camelCase, sometimes not. Sometimes abbreviations, sometimes not. Just to list a few examples:
I know it is still early stage of development, but especially for newcomers this can be quite irritating and a hurdle for contribution. In my opinion the project should decide on / define a consistent style guide which everyone should adhere to. This would greatly increase the readability and
accessibility of the hashspace source code. What is the general opinion on this?
I agree that we could come up with a set of coding rules to be followed for new contributors. Up until now, Bertrand was practically the only one committing (thus the abbreviated pre-minified variable names ) but it makes sense to have more consistency across the code base from all participants, especially at this early stage.
I'll bring up the issue to Github.
BTW we've got a number of inconsistencies like this in AT (I'm trying to address them from time to time when I see something but certainly this is one thing to have a solid look at). For instance, some events/functions are named `onfoo`, others `onFoo` etc...
Big +1 here, cryptic variable and function names make it difficult for code readers.
Issue opened on GH.