Update General Code Style

sparkbox / standard

How we work and best practices

292 stars 52 forks source link

Open lindseywild opened 5 years ago

lindseywild commented 5 years ago

This came out of an HTML & CSS Task Force meeting.

Update or add general code style info:

Tabs, no trailing white space, empty lines at the bottom of files, how linters are setup
How we write comments
Provide examples in our existing projects of good implementation of the standards
Reorganize things if necessary
Anything else!

mdt2 commented 4 years ago

[x] Tabs (already covered in the "use two spaces" piece)
[x] No trailing white space (already covered)
[x] Empty lines at the bottom of files (already covered)
[x] How linters are setup (linters are already mentioned in the build_process readme with links to documentation on setting them up)
[x] How we write comments (added some additional details about this)

This ended up being a much smaller PR than I expected: https://github.com/sparkbox/standard/pull/197