Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

introduce coding style standard for easier to read pull requests #121

Closed
hennr opened this issue Mar 21, 2017 · 3 comments
Closed

introduce coding style standard for easier to read pull requests #121

hennr opened this issue Mar 21, 2017 · 3 comments

Comments

@hennr
Copy link
Collaborator

hennr commented Mar 21, 2017

As pull requests are harder to read on github's web ui if spaces are replaced with tabs or vice versa I suggest to introduce a standard for that.

editorconfig seems to be an option. We could add a file (.editorconfig) to the repo which is picked up by some IDEs (e.g. intelliJ) per default. Many other IDEs are supported via plugins.

I would start with this config and see how it goes if there are no vetoes:

root = true

[**]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
@hennr
Copy link
Collaborator Author

hennr commented Mar 26, 2017

I pushed the suggested config.

@mpatric Do you want to reformat or should I do it?

@mpatric
Copy link
Owner

mpatric commented Mar 30, 2017

@hennr you can do it

@hennr
Copy link
Collaborator Author

hennr commented Apr 1, 2017

I just did the reformat and noticed that this is a big commit.

Tabs are used more often than spaces in the project so far, so I changed the .editorconfig to use tabs.
This leads to a smaller commit and thus preserves more of the old commit messages.

@hennr hennr closed this as completed in 3bd2057 Apr 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants