From c1dc1d858b2a4a04755b113117e214902bc72144 Mon Sep 17 00:00:00 2001 From: Darklighter Date: Wed, 26 Feb 2025 23:32:37 +0000 Subject: [PATCH] 1.5) GitHub Guidelines 2 aktualisiert --- 1.5%29-GitHub-Guidelines-2.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/1.5%29-GitHub-Guidelines-2.md b/1.5%29-GitHub-Guidelines-2.md index 08e2a64..8a9cd1c 100644 --- a/1.5%29-GitHub-Guidelines-2.md +++ b/1.5%29-GitHub-Guidelines-2.md @@ -1,12 +1,14 @@ 4. Leave the Description Optional -> -> Use the description field sparingly: The commit description provides space for more detailed information about the change. While this is optional, it should be used to explain the "why" behind the change, not just the "what." -> -> Add context: If the change is complex or addresses a specific issue, include additional details in the description. For example, describe why you made the change or how it improves the codebase. -> -> Example: -> Commit Summary: "Fix authentication issue with OAuth" -> Description: "Resolved issue where the OAuth token was not being stored correctly, leading to authentication failures for users." +``` + +Use the description field sparingly: The commit description provides space for more detailed information about the change. While this is optional, it should be used to explain the "why" behind the change, not just the "what." + +Add context: If the change is complex or addresses a specific issue, include additional details in the description. For example, describe why you made the change or how it improves the codebase. + +Example: +Commit Summary: "Fix authentication issue with OAuth" +Description: "Resolved issue where the OAuth token was not being stored correctly, leading to authentication failures for users." +``` 5. Use Bullet Points for Multiple Changes