From b91edb86d3aea0041c285fd6d35cbee1539aac24 Mon Sep 17 00:00:00 2001 From: Marc Bernard <59966492+mbtools@users.noreply.github.com> Date: Fri, 9 Feb 2024 19:17:51 +0100 Subject: [PATCH] Using .editorconfig (#209) --- src/development-guide/read-first/guidelines.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/development-guide/read-first/guidelines.md b/src/development-guide/read-first/guidelines.md index 32a5d5ad7..ff44e8d63 100755 --- a/src/development-guide/read-first/guidelines.md +++ b/src/development-guide/read-first/guidelines.md @@ -46,7 +46,13 @@ The code must only reference standard SAP objects (classes, interfaces, DDIC typ 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. -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. +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. + +For more details, see [editorconfig.org](https://editorconfig.org). + +::: info +VS Code requires an extension for `.editorconfig` which you can find at [marketplace](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig). +::: ### Formatting the Source Code