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.

Sign up for GitHub

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

added .editorconfig #37865

Closed
wants to merge 2 commits into from
Closed

added .editorconfig #37865

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e72502c
added .editorconfig
Karthik-PM Nov 13, 2022
e1081ca
Update style-guide.md
Karthik-PM Nov 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions content/en/docs/contribute/style/style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -631,6 +631,34 @@ You can remove ... | You can easily remove ...
These steps ... | These simple steps ...
{{< /table >}}

### EditorConfig
For maintaing a constant coding style we would need you to maintain a .editorconfig file
so that the developers using different editors (like vim , emacs , atom , vscode etc) for the same project can contribute with the same style.

the .editorconfig used here is
```
[*]
end_of_line = lf
insert_final_newline = false
charset = utf-8
max_line_length = 80
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.{css,html,js,json,sass,md,mmark,toml,yaml}]
indent_style = space
indent_size = 2

[*.{sh}]
indent_style = space
indent_size = 4

[Makefile]
indent_style = tab
```
for more details on .editorconfig plugin click [here](https://editorconfig.org/#download)
## {{% heading "whatsnext" %}}

* Learn about [writing a new topic](/docs/contribute/style/write-new-topic/).
Expand Down