Minh Huy Nguyen - OSD600

GitHub RSS

First issue and PR for release 0.2 (OSD600)

Published: | Updated:

The first commit for release 0.2 was adding a simple feature to an open source project, which is called ‘editorConfig’ to help different developers maintain coding style no matter what text editor or IDE they use. This minor feature will help the code style more consistent even though there are many developers working in the same project and they have different style of coding.

I created a Pull request with a new file added to root directory of the project flush-promises

You can see my PR from here

# editorconfig.org
root = true

[*]
end_of_line = lf
charset = utf-8

trim_trailing_whitespace = true
insert_final_newline = true

indent_style = space
indent_size = 4

[package.json]
indent_size = 2 

Basically, the syntax for editorConfig file is pretty simple. I can use either ‘#’ or ‘;’ for comment. Then select the file/files that I want to maintain format using wildcard and apply some property.

As my commit above, for example [*] will select all files under root directory and insert_final_newline will add new line at the end of every files. Some properties I’m learning and trying to remember.

In future project when I need to work with other developer, I will definitely use this.