From ae298974edb84b5ced01bb95e87dcf4cc3ccf665 Mon Sep 17 00:00:00 2001 From: Darklighter Date: Wed, 26 Feb 2025 23:37:02 +0000 Subject: [PATCH] 1.5) GitHub Guidelines 1 aktualisiert --- 1.5%29-GitHub-Guidelines-1.md | 40 +++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/1.5%29-GitHub-Guidelines-1.md b/1.5%29-GitHub-Guidelines-1.md index 78c388c..9a38ba1 100644 --- a/1.5%29-GitHub-Guidelines-1.md +++ b/1.5%29-GitHub-Guidelines-1.md @@ -85,4 +85,44 @@ Focus each commit on one change: A commit should ideally contain a single logica Example: Good: "Add unit tests for user registration module" Bad: "Add unit tests and refactor login page" +``` + +8. Refer to Issues or Pull Requests + +``` +If your commit addresses an open issue or references a pull request, include the issue number in the commit message (using # followed by the issue number). + +Example: +Good: "Fix issue #45: Resolve crashing issue on app startup" +Bad: "Fix crashing issue" +``` + +9. Avoid Personal or Ambiguous Messages + +``` +Avoid using personal pronouns like "I" or "We" in commit messages. + +Commit messages should be professional and clearly communicate the change to other team members. + +Example: +Good: "Refactor data processing function" +Bad: "I refactored the data processing function" +``` + +10. Keep it Relevant to the Codebase + +``` +Commit messages should always be relevant to the changes made in the code. Don't use commit messages for unrelated updates, like changes to the documentation, unless the commit is specifically related to that task. + +Example: +Good: "Update CSS styling for homepage buttons" +Bad: "Update README" + +Example of a Good Commit Message: + +Commit Summary: "Add search bar functionality to the homepage" +Description: +Implemented search bar for better user experience. +Linked search functionality to the backend API. +Updated front-end to handle dynamic search queries. ``` \ No newline at end of file