[FEATURE] Add an .editorconfig file #940
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
oliverklee
force-pushed
the
feature/editorconfig
branch
from
db01531 to
047de46
Compare
JakeQZ
reviewed
Nov 22, 2020
| # MD files | ||
| [*.md] | ||
| indent_style = space | ||
| indent_size = 4 |
There was a problem hiding this comment.
Do we not have 2 spaces for indenting in .md files - e.g. in bulleted lists - or is the indentation for lists something different?
There was a problem hiding this comment.
According to these style guides, it's 4 spaces (for code and lists where we do not use use hanging indent determined by the number of digits):
- https://google.github.io/styleguide/docguide/style.html#nested-list-spacing
- https://guides.github.com/features/mastering-markdown/
- https://cirosantilli.com/markdown-style-guide/#indentation-of-content-inside-lists
This setting in the .editorconfig only determine what the tab key does, not what a linter might expect.
oliverklee
force-pushed
the
feature/editorconfig
branch
from
047de46 to
d902c09
Compare
This allows IDEs to automatically set the basic code formatting options. Fixes #781
oliverklee
force-pushed
the
feature/editorconfig
branch
from
d902c09 to
b734e95
Compare
JakeQZ
approved these changes
Nov 22, 2020
| # MD files | ||
| [*.md] | ||
| indent_style = space | ||
| indent_size = 4 |
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.
This allows IDEs to automatically set the basic code formatting options.
Fixes #781