search

sugarlabs / sugar-docs

Documentation for Contributors and Developers
86 stars 104 forks source link

Javascript style #188

Closed deadnamedimmer closed 4 years ago

deadnamedimmer commented 4 years ago

Created a new javascript-style.md page with the JavaScript specific styling information, and removed the old information from web-style.

deadnamedimmer commented 4 years ago

https://codein.withgoogle.com/dashboard/task-instances/5252621267369984/

@quozl @walterbender

walterbender commented 4 years ago

We need to link to the file in here the README.md file too. https://github.com/sugarlabs/sugar-docs/blob/master/README.md

deadnamedimmer commented 4 years ago

This should be all set now.

walterbender commented 4 years ago

The link to the JS doc in the README file is still wrong. You don't want the #.

quozl commented 4 years ago

@llaske, please review; does this also apply to Sugarizer as a Sugar project?

llaske commented 4 years ago

@quozl It could but I'm not in favor to impose coding styles. I prefer doing recommendation instead. Specifically, I'm against an indentation policy:

Use four spaces for indentation

Currently I ask to contributors to respect the original indentation of the author of the activity. If the author choose spaces, you should use spaces. If the author choose TAB, you should use TAB.

quozl commented 4 years ago

Thanks for the review.

quozl commented 4 years ago

@NathanDimmer, @walterbender, please adjust the policy accordingly.

walterbender commented 4 years ago

Happy to adjust the policy, but FWIW, Nathan's PR did not change the existing policy as written. He just moved it to a separate file where it would be easier to find.