[ckan-dev] Front-end development style guides

[Aron Carroll]

Hi all,

I've been working on some initial style guides for the front end codebase. I aim for these to cover things like code formatting, testing and documentation as well as best practices and common patterns.

The work in progress is up here: http://aron.github.com/ckan-style/styleguide/

I'd love some feedback on the areas covered, especially with regard to the formatting. I've tried to keep it consistent with what's in the code base already but I'm happy to change it if theres a strong majority opposing a particular guideline.

Also I've built the first draft using Jekyll to make it easy to host on GitHub, however chatting with Sean it appears that Sphynx would have been the platform to use and to add it to the current docs directory in CKAN. So I'll look at moving it over to that unless anyone has any better suggestions.

I'll keep you all posted as I update the missing areas.

Cheers,
Aron