REM-Freelancer/REM-Mod
4
0
Fork 0
Code Issues 30 Pull Requests Actions Packages Projects Releases Wiki Activity

1.5) GitHub Guidelines 1 aktualisiert

Darklighter
2025-02-26 23:36:07 +00:00
parent 59c3d528a2
commit eccc8f6aff
1 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
1.5%29-GitHub-Guidelines-1.md

@@ -8,35 +8,41 @@ Here are the key rules and best practices for writing commit summaries in GitHub
1. Write a Short, Clear Summary 1. Write a Short, Clear Summary
```Keep it concise: The summary (or commit message title) should be brief—ideally under 50 characters. ```
Keep it concise: The summary (or commit message title) should be brief—ideally under 50 characters.
Describe the change: Clearly state what was changed. Avoid vague messages like "Fixed stuff" or "Changes made." Describe the change: Clearly state what was changed. Avoid vague messages like "Fixed stuff" or "Changes made."
Example: Example:
Good: "Fix bug in login form validation" Good: "Fix bug in login form validation"
Bad: "Fixed stuff"``` Bad: "Fixed stuff"
```
2. Use the Imperative Mood 2. Use the Imperative Mood
```Write in the imperative tone: Use verbs in the present tense, as if you're giving a command. This is the standard for commit messages in Git. ```
Write in the imperative tone: Use verbs in the present tense, as if you're giving a command. This is the standard for commit messages in Git.
Example: Example:
Good: "Update README with new setup instructions" Good: "Update README with new setup instructions"
Bad: "Updated README with new setup instructions" Bad: "Updated README with new setup instructions"
The imperative mood aligns with the idea that a commit is an action to be applied to the codebase.``` The imperative mood aligns with the idea that a commit is an action to be applied to the codebase.
```
3. Capitalize the First Letter 3. Capitalize the First Letter
```
```Capitalize the first letter of your commit message summary to make it consistent and professional. Capitalize the first letter of your commit message summary to make it consistent and professional.
Example: Example:
Good: "Add new feature to handle user input" Good: "Add new feature to handle user input"
Bad: "add new feature to handle user input"``` Bad: "add new feature to handle user input"
4. Leave the Description Optional
``` ```
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." 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. 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.
@@ -46,6 +52,7 @@ 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." 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 5. Use Bullet Points for Multiple Changes
``` ```