search

Heisenbergjs / heisenberg

A project base for building modern JavaScript applications
http://heisenbergjs.github.com/heisenberg/
156 stars 12 forks source link

Style guide #32

Closed OliverJAsh closed 11 years ago

jackfranklin commented 11 years ago

I like Idiomatic: https://github.com/rwldrn/idiomatic.js/

The main one for me is two spaces, no tabs :bomb:

OliverJAsh commented 11 years ago

I'll have to have a read of that, but I'm happy with whatever, as long as we're consistent :)

Read that idiomatic.js didn't support comma first and my heart broke a little bit.

jackfranklin commented 11 years ago

Read that idiomatic.js didn't support comma first and my heart broke a little bit.

I cannot stand comma first...sorry ;)

OliverJAsh commented 11 years ago

https://gist.github.com/357981/

On 22 Jan 2013, at 15:02, Jack Franklin notifications@github.com wrote:

Read that idiomatic.js didn't support comma first and my heart broke a little bit.

I cannot stand comma first...sorry ;)

— Reply to this email directly or view it on GitHub.

jackfranklin commented 11 years ago

I knew exactly what that gist was before I clicked it :+1:

Basically it's up to everyone who is going to be heavily involved, but picking some form of popular guide like Idiomatic or similar seems sensible.

jackfranklin commented 11 years ago

And we should decide this asap (aka today) as right now the JS is a complete mismash of styles.

boye commented 11 years ago

As for a documentation style, what do you guys think of the JSDoc notation?

Idiomatic.js says:

"JSDoc style is good, but requires a significant time investment"

OliverJAsh commented 11 years ago

Can you assign everyone to this issue? I'm on my phone.

Oliver

On 22 Jan 2013, at 15:17, Jack Franklin notifications@github.com wrote:

And we should decide this asap (aka today) as right now the JS is a complete mismash of styles.

— Reply to this email directly or view it on GitHub.

jackfranklin commented 11 years ago

Lets move this to #15.