[ckan-dev] Front-end development style guides

Tue May 8 10:19:28 UTC 2012

On 7 May 2012 18:01, Aron Carroll <aron.carroll.lists at gmail.com> wrote:

> 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.
>
>
looks good but as said not the right place for it

I really, really don't like the only use on var statement per function. do
not want.  Just had a quick scan of the idiomatic stuff I think I have
quite a few issues with their ideas ;)

Some stuff about namespaces would be good to have too

cheers

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
> _______________________________________________
> ckan-dev mailing list
> ckan-dev at lists.okfn.org
> http://lists.okfn.org/mailman/listinfo/ckan-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.okfn.org/pipermail/ckan-dev/attachments/20120508/407cf1da/attachment-0001.html>