Skip to content

Commit

Permalink
Update guidelines for object descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
mbtools authored Jan 25, 2024
1 parent 475531e commit 2ba4b15
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/development-guide/read-first/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@ Exceptions for existing objects:

#### Object Prefixing

Classes and interfaces are prefixed using `zcl_abapgit_` or `zif_abapgit_` (`zcx_abapgit_` for exception classes, `lcl_` and `ltcl_` for local and test classes). The description of objects should begin with `abapGit - ...`.
Classes and interfaces are prefixed using `zcl_abapgit_` or `zif_abapgit_` (`zcx_abapgit_` for exception classes, `lcl_` and `ltcl_` for local and test classes).

### Object Descriptions

The description of objects should begin with `abapGit - ...` (for example, `abapGit - Repository Content List`). For [serializer classes](/development-guide/serializers/overview.html), the text should contain the `TADIR` object type and description (for example, `abapGit - INTF - Interface (ABAP Objects)`).

#### Variable Prefixing

Expand Down

0 comments on commit 2ba4b15

Please sign in to comment.