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.

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

Using .editorconfig #209

Merged
merged 1 commit into from
Feb 9, 2024
Merged
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion src/development-guide/read-first/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading