Skip to content

Commit b91edb8

Browse files
authored
Using .editorconfig (#209)
1 parent f5f6b9c commit b91edb8

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/development-guide/read-first/guidelines.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,13 @@ The code must only reference standard SAP objects (classes, interfaces, DDIC typ
4646

4747
General file format guidelines are specified in [.editorconfig](https://github.com/abapGit/abapGit/blob/main/.editorconfig). If you are using abapGit to push files to the repository, these guidelines are followed automatically.
4848

49-
If you are editing files outside of SAP GUI or ADT, for example on GitHub.com or in VS Code, the most common issues are using `cr` instead of `lf` at end of line, missing new line at end of file, and missing `BOM` at beginning of XML files. Please ensure that your IDE is setup to follow the `.editorconfig` specifications to avoid any issues.
49+
If you are editing files outside of SAP GUI or ADT, for example on GitHub.com or in VS Code, the most common issues are using `cr` instead of `lf` at end of line, missing new line at end of file, and missing `BOM` at beginning of XML files. Please ensure that your IDE is setup to follow the `.editorconfig` specifications to avoid any issues.
50+
51+
For more details, see [editorconfig.org](https://editorconfig.org).
52+
53+
::: info
54+
VS Code requires an extension for `.editorconfig` which you can find at [marketplace](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig).
55+
:::
5056

5157
### Formatting the Source Code
5258

0 commit comments

Comments
 (0)