diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php new file mode 100644 index 0000000..60a344e --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,32 @@ +in(__DIR__) + ->exclude('includes/external') +; + +return (new PhpCsFixer\Config()) + ->setRules([ + '@PSR12' => true, + '@PHP82Migration' => true, + 'header_comment' => false, + 'single_class_element_per_statement' => false, + 'no_leading_import_slash' => false, + 'declare_strict_types' => false, + 'return_type_declaration' => [ + 'space_before' => 'none', + ], + 'declare_equal_normalize' => false, + 'lowercase_cast' => false, + 'lowercase_keywords' => true, + 'blank_line_between_import_groups' => false, + 'compact_nullable_type_declaration' => false, + 'ordered_class_elements' => false, + 'ordered_imports' => false, + + 'visibility_required' => [ + 'elements' => ['property', 'method'], + ], + ]) + ->setFinder($finder) +; \ No newline at end of file diff --git a/README.md b/README.md index e37ee3e..cd0cca7 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,41 @@ Dieses Repository dient dazu, sich mit Git-Befehlen und GitHub-Features vertraut ## 🚀 Nützliche Git-Befehle ```bash -git status # Aktueller Status -git add . # Alle Änderungen hinzufügen -git commit -m "Message" # Commit erstellen -git push # Zum Remote-Repository pushen -git pull # Änderungen holen +git clone # Repository klonen +git checkout -b # Erstellen eines Zweig-Branches aus dem aktuell ausgecheckten Branch +git status # Aktueller Status +git add . # Alle Änderungen hinzufügen +git add # Spezifische Änderungen hinzufügen +git commit -m "Message" # Commit erstellen +git pull # Änderungen holen und (default) HEAD mergen +git push # Zum Remote-Repository pushen ``` +## ✅ Best Practices +Um die Zusammenarbeit im Team zu optimieren, ist die Anwendung sogenannter Best Practices unerlässlich. +Deren konsequente Einhaltung steigert erheblich die Nachvollziehbarkeit der Änderungen, sowie die Wartbarkeit +und dadurch maßgeblich die Qualität der Software. Folgende Empfehlungen haben sich etabliert: + +- Tickernummern müssen im Branch-Namen erkenntlich sein + - origin/3050_main +- Änderungen sollten in kleineren Commits dokumentiert werden + - einheitliche und englischsprachige Commit-Nachrichten verwenden + - Ticketnummer in eckigen Klammern und kurzer Titel des Tickets + - Präfixe wie z.B. fix, feat, docs, usw. verwenden + - Der Betreff sollte mit einem Großbuchstaben beginnen +- regelmäßiges Synchronisieren des Forkes um Merge-Konflikte zu minimieren +### Example commit-msg: +``` +# [3050] Betreffzeile (max. 50 Zeichen) +# +# Längere Beschreibung mit 72 Zeichen pro Zeile (wrapped) +# Kurz erklären warum die Änderungen gemacht wurden +# und welche Auswirkungen diese haben +# +# Link zum Ticket kann hier optional eingefügt werden +``` + + ## 🥳 Git Online Browser Game Wer ein paar Git Grundlagen lernen oder auffrischen möchte, für den ist folgendes Browser Online Game etwas. In diesem Spiel kann man Git in kleinen Schritten spielerisch lernen. diff --git a/phpcs.xml.dist b/phpcs.xml.dist deleted file mode 100644 index 8493cef..0000000 --- a/phpcs.xml.dist +++ /dev/null @@ -1,62 +0,0 @@ - - - - PSR-12 als Basis, aber alle „logiknahen“ Regeln (Namespaces, Side Effects, - Strict Types, Typ-Decls etc.) sind deaktiviert. Es bleiben vor allem - Whitespace- und Formatierungsregeln übrig. - - - - includes/external/* - - - - - - - - - 0 - - - - 0 - - - - - 0 - - - - - 0 - - - - 0 - - - - - 0 - - - - - 0 - - - - - 0 - - - - - - - \ No newline at end of file