jsonresume / resume-schema

JSON-Schema is used here to define and validate our proposed resume json
http://jsonresume.org
MIT License
2.15k stars 277 forks source link

Use EditorConfig #73

Closed DonDebonair closed 10 years ago

DonDebonair commented 10 years ago

It might be useful to use EditorConfig to specify stuff like tabs vs spaces, tab-size etc. This is to prevent formatting issues such as in this PR: https://github.com/jsonresume/resume-schema/pull/15

thomasdavis commented 10 years ago

Great idea, best practises all the way!

On Wed, Jul 9, 2014 at 10:05 PM, Daan Debie notifications@github.com wrote:

It might be useful to use EditorConfig http://editorconfig.org/ to specify stuff like tabs vs spaces, tab-size etc. This is to prevent formatting issues such as in this PR: #15 https://github.com/jsonresume/resume-schema/pull/15

— Reply to this email directly or view it on GitHub https://github.com/jsonresume/resume-schema/issues/73.

Thomas Davis http://thomasdav.is

VP of Tech - Earbits - http://earbits.com Co-founder - Cdnjs - http://cdnjs.com Founder - Backbone Tutorials - http://backbonetutorials.com

DonDebonair commented 10 years ago

I don't have a clue about best practises in the JS/JSON world, so could anyone with more insights chime in? :)

thomasdavis commented 10 years ago

Well I've wrote a lot of the infrastructure code with 2 spaces, so we might just go with that to save a flame war =D

On Wed, Jul 9, 2014 at 10:07 PM, Daan Debie notifications@github.com wrote:

I don't have a clue about best practises in the JS/JSON world, so could anyone with more insights chime in? :)

— Reply to this email directly or view it on GitHub https://github.com/jsonresume/resume-schema/issues/73#issuecomment-48461308 .

Thomas Davis http://thomasdav.is

VP of Tech - Earbits - http://earbits.com Co-founder - Cdnjs - http://cdnjs.com Founder - Backbone Tutorials - http://backbonetutorials.com

DonDebonair commented 10 years ago

I'd propose this then:

root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

# indentation
indent_style = space
indent_size = 2

# Charset
charset = utf-8

# Markdown
[*.md]
trim_trailing_whitespace = false

I could add it, but I'm not sure about the process. Even though I have write access, do I still fork and make a PR?

thomasdavis commented 10 years ago

Feel free to directly commit, definitely add this in. NPM publishing is the part we have to be cautious with

On Wed, Jul 9, 2014 at 10:17 PM, Daan Debie notifications@github.com wrote:

I'd propose this then:

root = true

Unix-style newlines with a newline ending every file

[*] end_of_line = lf insert_final_newline = true trim_trailing_whitespace = true

indentation

indent_style = space indent_size = 2

Charset

charset = utf-8

Markdown

[*.md] trim_trailing_whitespace = false

I could add it, but I'm not sure about the process. Even though I have write access, do I still fork and make a PR?

— Reply to this email directly or view it on GitHub https://github.com/jsonresume/resume-schema/issues/73#issuecomment-48462171 .

Thomas Davis http://thomasdav.is

VP of Tech - Earbits - http://earbits.com Co-founder - Cdnjs - http://cdnjs.com Founder - Backbone Tutorials - http://backbonetutorials.com

DonDebonair commented 10 years ago

Fixed in this commit: https://github.com/jsonresume/resume-schema/commit/9d7d56903c81f60b8f56cc54b7e9ac1a4f91d67c I'll leave it to you to close this issue @thomasdavis in case you ha :)e some additions/remarks.

thomasdavis commented 10 years ago

Double checked, all is swell!