From 3d94802bebfe2cbc6f852eb09f1c4fc67b6ad783 Mon Sep 17 00:00:00 2001 From: Frederik Beimgraben Date: Tue, 3 Dec 2024 12:39:03 +0100 Subject: [PATCH] docs[README]: Add Style guidelines to README.md Commit message guidelines and variable naming. --- .idea/.gitignore | 8 + .idea/MMS-Loesung-2024-25.iml | 8 + .idea/editor.xml | 580 ++++++++++++++++++++++++++++++++++ .idea/modules.xml | 8 + .idea/vcs.xml | 6 + README.md | 8 +- 6 files changed, 617 insertions(+), 1 deletion(-) create mode 100644 .idea/.gitignore create mode 100644 .idea/MMS-Loesung-2024-25.iml create mode 100644 .idea/editor.xml create mode 100644 .idea/modules.xml create mode 100644 .idea/vcs.xml diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..13566b8 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/MMS-Loesung-2024-25.iml b/.idea/MMS-Loesung-2024-25.iml new file mode 100644 index 0000000..bc2cd87 --- /dev/null +++ b/.idea/MMS-Loesung-2024-25.iml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/editor.xml b/.idea/editor.xml new file mode 100644 index 0000000..95d51a7 --- /dev/null +++ b/.idea/editor.xml @@ -0,0 +1,580 @@ + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..1ec52fe --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/README.md b/README.md index 5d1bec0..1e172b6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ # MMS-Loesung-2024-25 -MMS-Lösung zum Headerfile im WiSe 2024/25 \ No newline at end of file +MMS-Lösung zum Headerfile im WiSe 2024/25 + +## Code Style and Conventions + +We adhere to the [Angular Commit Message Conventions](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) + +Function names as well as variables should be written in camelCase. \ No newline at end of file