[orion-dev] Orion coding conventions

[Mark Macdonald <mamacdon@xxxxxxxxx>]

I've beefed up the Coding Conventions [1] page on the Orion wiki.

This page has been sparse for a long time as Orion evolved, but I think we're now in a good position to flesh it out. I've started by adding some sections on:

• Style tips
  
• JS pitfalls to avoid
• Recipes for common tasks in Orion: writing an AMD module, creating a URL, making an XHR call, writing a visual component with an HTML template, etc.
• Where things should go in the source tree (pages, CSS, etc)

This knowledge currently exists only in contributors' heads, so I'd like to formally capture as much of it on this page as we can. In particular, the HTML and "visual component" sections need some help.

If you have any tips that might help other contributors (especially new contributors), please add to it. Basically any time you find yourself saying "Wow, I'll never do that again", it's probably something worth including.

Mark

[1] http://wiki.eclipse.org/Orion/Coding_conventions