search

Shift3 / standards-and-practices

Standards and Practices for Bitwise Industries
https://shift3.github.io/standards-and-practices/
63 stars 41 forks source link

docs(editorconfig): Add EditorConfig documentation and example. #311

Closed dmpayton closed 2 years ago

dmpayton commented 2 years ago

Changes

  1. Add docs for EditorConfig to the best-practices directory.
  2. Add link to EditorConfig docs to the Project Setup section of the S&P README.

Purpose

I'm a big fan of consistent code styling, and an even bigger fan of automating that process as much as possible. This is one step to help us do ... that.

Approach

By adding this to the S&P docs, we can start getting BWTC devs to add .editorconfig files to their projects. Many of them are already doing so, but this helps set it as a standard.

Pre-Testing TODOs

N/A

Testing Steps

N/A

Learning

Main website: https://editorconfig.org/

Examples we can pull from: https://github.com/editorconfig/editorconfig/wiki/Projects-Using-EditorConfig

Properties we can set: https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties

Closes #307.

dmpayton commented 2 years ago

Before merging, a couple questions to be answered...

1) What editors are common at BWTC? Is the list I have good enough? Is there anything missing? Does anyone really use emacs here?

2) Is the sample .editorconfig file sufficient? What's missing from it? Are we using any languages or stacks where (the obviously inferior) tabs are the recommended practice over spaces?

mwallert commented 2 years ago

@dmpayton The only person I know who uses emacs is @DropsOfSerenity the legend himself.

That said I think the IDE list is good and covers most of the shop (last I checked could be off), the only ones missing would be the JetBrains IDEs (WebStorm, PHPStorm, and maybe PyCharm? <- names could be super wrong as well I don't use them :joy:) that I think some of our devs use.

mwallert commented 2 years ago

Also would probably be worth linking the silicon valley video clip on tabs vs spaces in the poll :joy:

dmpayton commented 2 years ago

The only person I know who uses emacs is @DropsOfSerenity the legend himself.

There's always one... 😂

... the only ones missing would be the JetBrains IDEs ...

Noted, I'll get 'em added.

I wonder if a poll (that could start WW3) should be cast in the technical channel to see what indent space people are using?

"Hi, many of y'all don't know me, but I'm here to set off this tactical nuke. 💣"

I'll probably hold off on the poll for now, it's pretty easy to adjust within projects as needed.

Also would probably be worth linking the silicon valley video clip on tabs vs spaces

https://www.youtube.com/watch?v=SsoOG6ZeyUI

So good!

michaelachrisco commented 2 years ago

The only person I know who uses emacs is @DropsOfSerenity the legend himself.

There's always one... 😂

... the only ones missing would be the JetBrains IDEs ...

Noted, I'll get 'em added.

I wonder if a poll (that could start WW3) should be cast in the technical channel to see what indent space people are using?

"Hi, many of y'all don't know me, but I'm here to set off this tactical nuke. 💣"

I'll probably hold off on the poll for now, it's pretty easy to adjust within projects as needed.

Also would probably be worth linking the silicon valley video clip on tabs vs spaces

https://www.youtube.com/watch?v=SsoOG6ZeyUI

So good!

dooo itttt XD