Add note about editorconfig to CONTRIBUTING.md #4136
Merged
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
dedemorton
reviewed
Apr 28, 2017
CONTRIBUTING.md
Outdated
| @@ -72,6 +72,10 @@ Packetbeat: | |||
| Some of the Beats might have extra development requirements, in which case you'll find a | |||
| CONTRIBUTING.md file in the Beat directory. | |||
|
|
|||
| We use an [EditorConfig](http://editorconfig.org/) file in the beats repository to standardise | |||
| how different editors use whitespaces etc. in our files. Most popular editors have a | |||
There was a problem hiding this comment.
Avoid using "etc" because it can sometimes be a problem when the doc gets translated. How about being more specific?
...how different editors handle whitespace, line endings, and other coding styles in our files... (UPDATED)
There was a problem hiding this comment.
I guess tabs are technically whitespace...hehe. but I think you see the point...
dedemorton
reviewed
Apr 28, 2017
CONTRIBUTING.md
Outdated
| @@ -72,6 +72,10 @@ Packetbeat: | |||
| Some of the Beats might have extra development requirements, in which case you'll find a | |||
| CONTRIBUTING.md file in the Beat directory. | |||
|
|
|||
| We use an [EditorConfig](http://editorconfig.org/) file in the beats repository to standardise | |||
| how different editors use whitespaces etc. in our files. Most popular editors have a | |||
| [plugin](http://editorconfig.org/#download) for EditorConfig and we strongly recommend you to install it. | |||
There was a problem hiding this comment.
"we strongly recommend that you install it..."
ruflin
force-pushed
the
editorconfig-contributing
branch
from
07d3009 to
dc69938
Compare
|
@dedemorton New version pushed. |
|
LGTM |
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.
No description provided.