Bug 20227 - Uniform Code Style Guidelines, at least within each language
Uniform Code Style Guidelines, at least within each language
Status: NEW
Product: webplatform.org
Classification: Unclassified
Component: content
unspecified
All All
: P2 normal
: ---
Assigned To: Chris Mills
public-webplatform-bugs list
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2012-12-04 08:22 UTC by Mayank Singhal
Modified: 2012-12-07 04:05 UTC (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Mayank Singhal 2012-12-04 08:22:35 UTC
I realize that the project is still new and that it might be too soon to fight for consensus on this controversial topic but any delay in discussing this will only increase the clean up work in future.

Current style guide[1], only provides style guidelines for the wiki and not for the code itself.

[1] http://docs.webplatform.org/wiki/WPD:Style_Guide
Comment 1 Jonathan Garbee 2012-12-04 10:18:18 UTC
This is actually something that was started a while ago but the talk just died out around it. A few pages for it are:

http://docs.webplatform.org/wiki/WPD:Content/coding_guidelines/css
and
http://docs.webplatform.org/wiki/WPD:Content/coding_guidelines/html

Albeit the HTML has nothing in it.  We should improve those two as needed and then create new guidelines for other languages.
Comment 2 Eliot Graff 2012-12-06 20:32:24 UTC
There's also some information in this topic:

https://www.w3.org/Bugs/Public/show_bug.cgi?id=20227 

It's purposefully vague, but it's something to use either as a reference or a starting point (or a point of departure).
Comment 3 Mayank Singhal 2012-12-06 20:54:43 UTC
@Jonathan
Thanks, I will see if I can contribute there.

@Eliot
I think you linked to this bug itself.
Comment 4 Eliot Graff 2012-12-07 04:05:27 UTC
Oops. Sorry about that. The page lives at http://docs.webplatform.org/wiki/WPD:Manual_Of_Style/Sample_best_practices

It's still purposefully vague.

Thanks,
E