728425 - Add a coding style guide to the docs

Status: RESOLVED FIXED

(Mozilla QA Graveyard :: MozTrap, defect)

Description

[Carl Meyer (:carljm)]

Referencing PEP 8 and PEP 257 and other style issues we try to stay consistent on.

Comment 1

[Cameron Dawson [:camd]]

A Pivotal Tracker story has been created for this Bug: http://www.pivotaltracker.com/story/show/25143373

Comment 2

[Cameron Dawson [:camd]]

Carl Meyer changed story state to started in Pivotal Tracker

Comment 3

[Cameron Dawson [:camd]]

Carl Meyer changed story state to finished in Pivotal Tracker

Comment 4

[Cameron Dawson [:camd]]

Carl Meyer changed story state to delivered in Pivotal Tracker

Comment 5

[Cameron Dawson [:camd]]

Carl Meyer added a comment in Pivotal Tracker:   
   
jonny and eric: if either of you have anything you'd like to document for potential future authors about coding standards for Javascript and Sass, feel free to add it in "docs/standards.rst". I already added a (very brief) Javascript section to mention JSLint; I didn't add a Sass section yet as I had nothing to put there. You can look over the Python ones for ideas of things you might want to mention: http://case-conductor.readthedocs.org/en/latest/standards.html

Comment 6

[Cameron Dawson [:camd]]

Cameron Dawson changed story state to accepted in Pivotal Tracker