canonical-web-and-design / practices

Guides and principles from the web team at Canonical and Ubuntu
https://canonical-web-and-design.github.io/practices/
Other
45 stars 30 forks source link

Code-Formatting Page JS heavy #119

Closed b-m-f closed 5 years ago

b-m-f commented 5 years ago

https://canonical-webteam.github.io/practices/coding/code-formatting seems very focussed on JavaScript. Should we move the first sentence:

To ensure consistency across our codebases, we utilise Prettier.

into the JavaScript block?

How about keeping Code-Formatting rules in the respective language documents => Maybe quicker to find the info for the language I am looking up?

nottrobin commented 5 years ago

Yes I think these should be separated into one doc per language, that's probably a more useful grouping.

barrymcgee commented 5 years ago

Prettier is not just JS focussed - it formats HTML, Scss, Markdown, JSON and much more...

screenshot 2018-11-22 at 11 23 59
nottrobin commented 5 years ago

True, but we use Black for Python, so I still think it's useful to simply mention Prettier under all languages it applies to. Although I'm not strongly opinionated about it.

squidsoup commented 5 years ago

Fixed in https://github.com/canonical-webteam/practices/pull/123