diff --git a/1.5%29-GitHub-Guidelines-2.md b/1.5%29-GitHub-Guidelines-2.md deleted file mode 100644 index f755756..0000000 --- a/1.5%29-GitHub-Guidelines-2.md +++ /dev/null @@ -1,45 +0,0 @@ -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." -``` - -5. Use Bullet Points for Multiple Changes - -``` -If your commit contains multiple changes, you can use bullet points in the description to make it easier to read. - -Example: - -Commit Summary: "Refactor login system" -Description: -Refactored user authentication logic. -Improved error handling for failed login attempts. -Updated unit tests for new authentication flow. -``` - -6. Be Specific and Descriptive - -``` -Be specific about the changes: If you're fixing a bug, adding a feature, or refactoring code, be specific about what was modified and how it impacts the project. - -Example: -Good: "Fix image upload issue on mobile devices" -Bad: "Fix bugs" -``` - -7. Avoid Large, Unfocused Commits - -``` -Focus each commit on one change: A commit should ideally contain a single logical change, like fixing a bug, adding a feature, or refactoring a part of the codebase. Large commits that combine unrelated changes make it harder to understand the history of the project. - -Example: -Good: "Add unit tests for user registration module" -Bad: "Add unit tests and refactor login page" -``` \ No newline at end of file