EditorConfig

Maintain coding style conventions using EditorConfig.

I like working in a codebase with a consistent coding style. Variations in coding style surprise me. In programming, surprise is not good.

To help maintain a consistent coding style, I use EditorConfig. It is a configuration file that exists in the repository just like a .gitignore file. Many code editors support EditorConfig, including Visual Studio. In fact, Visual Studio can export its code style settings as an EditorConfig file.

EditorConfig is especially helpful when working in a team. Part of my onboarding process used to include giving the new programmer my Visual Studio settings file that only contained my text editor settings. Now their copy of Visual Studio will automatically use the coding style defined in the EditorConfig file.

To help you get started, you can use my EditorConfig file. For each setting, the choice I made is less important than that fact that I made a choice. It is fine to choose different settings. The important thing is that you have some EditorConfig file.

linkSummary

Use EditorConfig to store coding style conventions and to efficiently share those conventions with everyone on your team.


linkTags

The tags feature of Coding Blog Plugin is still being developed. Eventually the tags will link somewhere.

#DevOps #Teamwork

linkComments

SummaryTagsComments

Home About Archive