Naming Conventions#

Naming Conventions of Files#

The overall naming convention is to use snake case for all files and folders (all files are named lowercase and spaces are replaced by underscores).

For drawio pictures use the extension .drawio.svg - this enables the tooling to recognize a picture as modifiable by drawio.

Naming Convention for UIDs#

The naming convention for the UIDs of all elements shall be defined as follows:

  • It should not exceed 30 characters

  • It shall show a meaningful name

  • It shall only consist of lowercase, digits and underscores

For the naming of the UIDs also following convention shall be applied:

  • It shall consist of 3 parts separated by double underscore
    • prefix
      (defined in the Metamodel)
    • structural element
      (e.g. abbreviation for the feature / subfeature)
    • keyword (s)
      (keyword(s) referring the the description, separated by underscore)

As examples:

  • feat_req__ipc__e2e_protection

  • comp_req__kvs__storage

Only for process UIDs the structural element is optional:

  • gd_temp__review

  • gd_req__req__structure

Naming convention for git branches#

In order to keep an overview which branch belongs to whom the branch name also should be descriptive. The following rules shall apply:

  1. The branch name shall start with your github username. This will make it easier for everybody to identify the owner of the branch.

  2. Branch names must be lower case.

  3. Concatenation is done by underscores _.

An example could look like this:

Mustermann, GitHub Name: maximuster

maximuster_my_awesome_branch_name