Skip to content

Commit f5f6b9c

Browse files
authored
Add file format guidelines (#203)
1 parent 7e0ee82 commit f5f6b9c

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ abapGit is targeted for [version 7.02](https://help.sap.com/doc/abapdocu_latest_
4242

4343
The code must only reference standard SAP objects (classes, interfaces, DDIC types) that exist in version 7.02 and higher. Referencing objects that do *not* exist in 7.02 creates syntax errors and therefore requires using dynamic ABAP. DDIC types that do *not* exist in 7.02 should be replaced by local type definitions.
4444

45+
### File Formats
46+
47+
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.
48+
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+
4551
### Formatting the Source Code
4652

4753
#### Line Width

0 commit comments

Comments
 (0)