[MINOR UPDATE]: Add an .editorconfig file providing style hints to editors and IDEs #2281
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
EditorConfig (https://editorconfig.org/) is an editor-neutral file format that holds code style settings. This particular config has been defined to reflect the style convetions in the Drill codebase (most significantly, indentation is with 2 spaces). Most mainstream editors and IDEs will recognise this file and set themselves up accordingly, making it easier to contribute code following the project's conventions. Note that .editorconfig only contains global conventions for codebase, not individual users' editor preferences, which must be masked by .gitignore. Other Apache projects with a .editorconfig file in their code repo are Superset, Subversion, Thrift, Submarine and presumably some more.
|
@dzamo |
cgivre
requested changes
Jul 29, 2021
|
Thanks, I've added the Apache license. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Non-code change.
EditorConfig (https://editorconfig.org/) is an editor-neutral file format
that holds code style settings. This particular config has been defined
to reflect the style convetions in the Drill codebase (most significantly,
indentation is with 2 spaces). Many mainstream editors and IDEs will
recognise this file and set themselves up accordingly, making it easier to
contribute code following the project's conventions. Editors that do not
understand EditorConfig are unaffected.
Note that .editorconfig only contains global conventions for the codebase, not
individual users' editor preferences, which must be masked by .gitignore.
Other Apache projects with a .editorconfig file in their code repo are
Superset, Subversion, Thrift, Submarine and presumably some more.